feat: adapt to latest did core spec and libs (uport-project#61)

* chore(deps): update deps * feat: adapt to latest did core spec BREAKING CHANGE: new did core spec uses different format for DID documents and resolution. BREAKING CHANGE: Now using ethers.js which means that providers and signers may have a different API BREAKING CHANGE: default export was removed closes uport-project#50 closes uport-project#59 closes uport-project#21 closes uport-project#49 closes uport-project#51 closes uport-project#52 closes uport-project#57 closes uport-project#58
coincord · Apr 15, 2021 · 839079d · 839079d
1 parent 5c86c9f
commit 839079d
Show file tree

Hide file tree

Showing 11 changed files with 8,138 additions and 11,361 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,11 @@
+module.exports = {
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
+  extends: [
+    'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    'prettier',
+  ],
+  parserOptions: {
+    ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
+    sourceType: 'module', // Allows for the use of imports
+  },
+}
diff --git a/.prettierrc b/.prettierrc
@@ -1,8 +1,8 @@
 {
   "jsxBracketSameLine": false,
-  "trailingComma": "none",
   "tabWidth": 2,
-  "printWidth": 80,
+  "printWidth": 120,
   "singleQuote": true,
+  "trailingComma": "es5",
   "semi": false
 }
diff --git a/README.md b/README.md
@@ -1,57 +1,79 @@
-
-
 [![npm](https://img.shields.io/npm/dt/ethr-did.svg)](https://www.npmjs.com/package/ethr-did)
 [![npm](https://img.shields.io/npm/v/ethr-did.svg)](https://www.npmjs.com/package/ethr-did)
 [![Join the chat at](https://img.shields.io/badge/Riot-Join%20chat-green.svg)](https://chat.uport.me/#/login)
 [![Twitter Follow](https://img.shields.io/twitter/follow/uport_me.svg?style=social&label=Follow)](https://twitter.com/uport_me)
 
 # Ethr-DID Library
 
-[DID Specification](https://w3c-ccg.github.io/did-spec/) | [ERC-1056](https://github.com/ethereum/EIPs/issues/1056) | [Getting Started](/docs/guides/index.md)
+[DID Specification](https://w3c-ccg.github.io/did-spec/) | [ERC-1056](https://github.com/ethereum/EIPs/issues/1056)
+| [Getting Started](/docs/guides/index.md)
 
 [FAQ and helpdesk support](http://bit.ly/uPort_helpdesk)
 
-This library conforms to [ERC-1056](https://github.com/ethereum/EIPs/issues/1056) and is intended to use Ethereum addresses as fully self-managed [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/#decentralized-identifiers-dids) (DIDs), it allows you to easily create and manage keys for these identities.  It also lets you sign standards compliant [JSON Web Tokens (JWT)](https://jwt.io) that can be consumed using the [DID-JWT](https://github.com/uport-project/did-jwt) library.
+This library conforms to [ERC-1056](https://github.com/ethereum/EIPs/issues/1056) and is intended to use Ethereum
+addresses as fully
+self-managed [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/#decentralized-identifiers-dids) (DIDs), it
+allows you to easily create and manage keys for these identities. It also lets you sign standards
+compliant [JSON Web Tokens (JWT)](https://jwt.io) that can be consumed using
+the [DID-JWT](https://github.com/uport-project/did-jwt) library.
 
-This library can be used to create a new ethr-did identity.  It allows ethr-did identities to be represented as an object that can perform actions such as updating its did-document, signing messages, and verifying messages from other dids.
+This library can be used to create a new ethr-did identity. It allows ethr-did identities to be represented as an object
+that can perform actions such as updating its did-document, signing messages, and verifying messages from other dids.
 
-Use this if you are looking for the easiest way to start using ethr-did identities, and want high-level abstractions to access its entire range of capabilities.  It encapsulates all the functionality of [ethr-did-resolver](https://github.com/decentralized-identity/ethr-did-resolver) and [ethr-did-registry](https://github.com/uport-project/ethr-did-registry).
+Use this if you are looking for the easiest way to start using ethr-did identities, and want high-level abstractions to
+access its entire range of capabilities. It encapsulates all the functionality
+of [ethr-did-resolver](https://github.com/decentralized-identity/ethr-did-resolver)
+and [ethr-did-registry](https://github.com/uport-project/ethr-did-registry).
 
-A DID is an Identifier that allows you to lookup a DID document that can be used to authenticate you and messages created by you.
+A DID is an Identifier that allows you to lookup a DID document that can be used to authenticate you and messages
+created by you.
 
-Ethr-DID provides a scalable identity method for Ethereum addresses that gives any Ethereum address the ability to collect on-chain and off-chain data. Because Ethr-DID allows any Ethereum key pair to become an identity, it is more scalable and privacy-preserving than smart contract based identity methods, like our previous [Proxy Contract](https://github.com/uport-project/uport-identity/blob/develop/docs/reference/proxy.md).
+Ethr-DID provides a scalable identity method for Ethereum addresses that gives any Ethereum address the ability to
+collect on-chain and off-chain data. Because Ethr-DID allows any Ethereum key pair to become an identity, it is more
+scalable and privacy-preserving than smart contract based identity methods, like our
+previous [Proxy Contract](https://github.com/uport-project/uport-identity/blob/develop/docs/reference/proxy.md).
 
-This particular DID method relies on the [Ethr-Did-Registry](https://github.com/uport-project/ethr-did-registry). The Ethr-DID-Registry is a smart contract that facilitates public key resolution for off-chain (and on-chain) authentication. It also facilitates key rotation, delegate assignment and revocation to allow 3rd party signers on a key's behalf, as well as setting and revoking off-chain attribute data. These interactions and events are used in aggregate to form a DID's DID document using the [Ethr-Did-Resolver](https://github.com/uport-project/ethr-did-resolver).
+This particular DID method relies on the [Ethr-Did-Registry](https://github.com/uport-project/ethr-did-registry). The
+Ethr-DID-Registry is a smart contract that facilitates public key resolution for off-chain (and on-chain)
+authentication. It also facilitates key rotation, delegate assignment and revocation to allow 3rd party signers on a
+key's behalf, as well as setting and revoking off-chain attribute data. These interactions and events are used in
+aggregate to form a DID's DID document using the [Ethr-Did-Resolver](https://github.com/uport-project/ethr-did-resolver)
+.
 
 An example of a DID document resolved using the Ethr-Did-Resolver:
 
-```
+```javascript
 {
-  '@context': 'https://w3id.org/did/v1',
+  '@context': [
+    'https://www.w3.org/ns/did/v1',
+    'https://identity.foundation/EcdsaSecp256k1RecoverySignature2020/lds-ecdsa-secp256k1-recovery2020-0.0.jsonld'
+  ],
   id: 'did:ethr:0xb9c5714089478a327f09197987f16f9e5d936e8a',
-  publicKey: [{
-       id: 'did:ethr:0xb9c5714089478a327f09197987f16f9e5d936e8a#owner',
-       type: 'Secp256k1VerificationKey2018',
-       owner: 'did:ethr:0xb9c5714089478a327f09197987f16f9e5d936e8a',
-       ethereumAddress: '0xb9c5714089478a327f09197987f16f9e5d936e8a'}],
-  authentication: [{
-       type: 'Secp256k1SignatureAuthentication2018',
-       publicKey: 'did:ethr:0xb9c5714089478a327f09197987f16f9e5d936e8a#owner'}]
+  verificationMethod: [
+    {
+      id: `did:ethr:0xb9c5714089478a327f09197987f16f9e5d936e8a#controller`,
+      type: 'EcdsaSecp256k1RecoveryMethod2020',
+      controller: did,
+      blockchainAccountId: `did:ethr:0xb9c5714089478a327f09197987f16f9e5d936e8a@eip155:1`
+    }
+  ],
+  authentication: [`did:ethr:0xb9c5714089478a327f09197987f16f9e5d936e8a#controller`]
 }
 ```
 
-On-chain refers to something that is resolved with a transaction on a blockchain, while off-chain can refer to anything from temporary payment channels to IPFS.
-
-It supports the proposed [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) spec from the [W3C Credentials Community Group](https://w3c-ccg.github.io).
+On-chain refers to something that is resolved with a transaction on a blockchain, while off-chain can refer to anything
+from temporary payment channels to IPFS.
 
+It supports the proposed [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) spec from
+the [W3C Credentials Community Group](https://w3c-ccg.github.io).
 
 ## DID Method
 
-A "DID method" is a specific implementation of a DID scheme that is identified by a `method name`. In this case, the method name is `ethr`, and the method identifier is an Ethereum address.
+A "DID method" is a specific implementation of a DID scheme that is identified by a `method name`. In this case, the
+method name is `ethr`, and the method identifier is an Ethereum address or a secp256k1 publicKey.
 
 To encode a DID for an Ethereum address, simply prepend `did:ethr:`
 
-
 For example:
 
 `did:ethr:0xf3beac30c498d9e26865f34fcaa57dbb935b0d74`
@@ -64,24 +86,35 @@ import EthrDID from 'ethr-did'
 // Assume web3 object is configured either manually or injected using metamask
 
 
-const ethrDid = new EthrDID({address: '0x...', privateKey: '...', provider})
+const ethrDid = new EthrDID({identifier: '0x...', privateKey: '...', provider})
 ```
 
 | key | description| required |
 |-----|------------|----------|
-|`address`|Ethereum address representing Identity| yes |
+|`identifier`|Ethereum address, public key or a full `did:ethr` representing Identity| yes |
+|`chainNameOrId`|The name or chainId of the ethereum network (defaults to 'mainnet') | no |
 |`registry`| registry address (defaults to `0xdca7ef03e98e0dc2b855be647c39abe984fcf21b`) | no |
-|`provider`| web3 provider | no |
-|`web3`| preconfigured web3 object | no |
-|`rpcUrl`| JSON-RPC endpoint url | no |
+|`provider`| web3 provider | either `provider` or `web3` or `rpcUrl` |
+|`web3`| preconfigured web3 object | either `provider` or `web3` or `rpcUrl` |
+|`rpcUrl`| JSON-RPC endpoint url | either `provider` or `web3` or `rpcUrl` |
 |`signer`| [Signing function](https://github.com/uport-project/did-jwt#signer-functions)| either `signer` or `privateKey` |
+|`txSigner`| [Ethers.js Signer](https://docs.ethers.io/v5/api/signer/#Signer)| either `txSigner` or `privateKey` |
 |`privateKey`| Hex encoded private key | yes* |
 
-**Note**
-An instance created using only an address can only be used to encapsulate an external ethr-did (one where there is no access to the private key).
-This instance will not have the ability to sign anything, but it can be used for a subset of actions:
+## Notes
+
+### Readonly ethr-did
+An instance created using only an address can only be used to encapsulate an external ethr-did (one where there is no
+access to the private key). This instance will not have the ability to sign anything, but it can be used for a subset of
+actions:
+
+* provide its own address (`ethrDid.address`)
+* provide the full DID string (`ethrDid.did`)
+* lookup its owner `await ethrDid.lookupOwner()`
+* verify a JWT `await ethrDid.verifyJwt(jwt)`
 
-*  provide its own address (`ethrDid.address`)
-*  provide the full DID string (`ethrDid.did`)
-*  lookup its owner `await ethrDid.lookupOwner()`
-*  verify a JWT `await ethrDid.verifyJwt(jwt)`
+### Multiple ethereum networks
+EthrDid can be configured to control a DID on any ethereum network.
+To do this, you mush specify the `chainNameOrId` during construction.
+Example:
+`new EthrDid({ address, 'rsk' }).did`