feat: add native resolver for did:key

fixes #352
decentralized-identity · Apr 16, 2021 · 18fa983 · 18fa983
1 parent 9e1af61
commit 18fa983
Show file tree

Hide file tree

Showing 9 changed files with 691 additions and 21 deletions.
diff --git a/__tests__/localAgent.test.ts b/__tests__/localAgent.test.ts
@@ -35,6 +35,7 @@ import {
 import { Resolver } from 'did-resolver'
 import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
+import { getDidKeyResolver } from '../packages/did-provider-key'
 import fs from 'fs'
 
 jest.setTimeout(30000)
@@ -125,6 +126,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
         resolver: new Resolver({
           ...ethrDidResolver({ infuraProjectId }),
           ...webDidResolver(),
+          ...getDidKeyResolver(),
         }),
       }),
       new DataStore(dbConnection),

diff --git a/__tests__/localMemoryStoreAgent.test.ts b/__tests__/localMemoryStoreAgent.test.ts
@@ -23,16 +23,12 @@ import {
   ISelectiveDisclosure,
   SdrMessageHandler,
 } from '../packages/selective-disclosure/src'
-import { KeyManagementSystem, SecretBox } from '../packages/kms-local/src'
-import {
-  Entities,
-  IDataStoreORM,
-  DataStore,
-  DataStoreORM,
-} from '../packages/data-store/src'
+import { KeyManagementSystem } from '../packages/kms-local/src'
+import { Entities, IDataStoreORM, DataStore, DataStoreORM } from '../packages/data-store/src'
 import { Resolver } from 'did-resolver'
 import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
+import { getDidKeyResolver } from '../packages/did-provider-key'
 import fs from 'fs'
 
 jest.setTimeout(30000)
@@ -123,6 +119,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
         resolver: new Resolver({
           ...ethrDidResolver({ infuraProjectId }),
           ...webDidResolver(),
+          ...getDidKeyResolver(),
         }),
       }),
       new DataStore(dbConnection),

diff --git a/__tests__/restAgent.test.ts b/__tests__/restAgent.test.ts
@@ -54,6 +54,7 @@ import documentationExamples from './shared/documentationExamples'
 import keyManager from './shared/keyManager'
 import didManager from './shared/didManager'
 import messageHandler from './shared/messageHandler'
+import { getUniversalResolver } from '../packages/did-resolver/src/universal-resolver'
 
 const databaseFile = 'rest-database.sqlite'
 const infuraProjectId = '5ffc47f65c4042ce847ef66a3fa70d4c'
@@ -132,6 +133,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
         resolver: new Resolver({
           ...ethrDidResolver({ infuraProjectId }),
           ...webDidResolver(),
+          key: getUniversalResolver(), // resolve using remote resolver
         }),
       }),
       new DataStore(dbConnection),

diff --git a/__tests__/shared/resolveDid.ts b/__tests__/shared/resolveDid.ts
@@ -23,6 +23,13 @@ export default (testContext: {
       expect(didDoc?.id).toEqual(didUrl)
     })
 
+    it('should resolve did:key', async () => {
+      const didUrl = 'did:key:z6Mkk7yqnGF3YwTrLpqrW6PGsKci7dNqh1CjnvMbzrMerSeL'
+      const result = await agent.resolveDid({ didUrl })
+      const didDoc = result.didDocument
+      expect(didDoc?.id).toEqual(didUrl)
+    })
+
     it('should return an error for unsupported did methods', async () => {
       expect.assertions(1)
       await expect(agent.resolveDid({ didUrl: 'did:foo:bar' })).resolves.toEqual({
@@ -46,7 +53,7 @@ export default (testContext: {
         didResolutionMetadata: { error: 'invalidDid' },
       })
       //@ts-ignore
-      await expect(agent.resolveDid({ didUrl: "garbage" })).resolves.toEqual({
+      await expect(agent.resolveDid({ didUrl: 'garbage' })).resolves.toEqual({
         didDocument: null,
         didDocumentMetadata: {},
         didResolutionMetadata: { error: 'invalidDid' },

diff --git a/packages/cli/default/default.yml b/packages/cli/default/default.yml
@@ -152,7 +152,7 @@ didResolver:
             web:
               $ref: /web-did-resolver
             key:
-              $ref: /universal-resolver
+              $ref: /did-key-resolver
             elem:
               $ref: /universal-resolver
             io:
@@ -188,6 +188,9 @@ universal-resolver:
   $args:
     - url: https://dev.uniresolver.io/1.0/identifiers/
 
+did-key-resolver:
+  $require: '@veramo/did-provider-key?t=function&p=/key#getDidKeyResolver'
+
 # Key Manager
 keyManager:
   $require: '@veramo/key-manager#KeyManager'

diff --git a/packages/did-provider-key/package.json b/packages/did-provider-key/package.json
@@ -9,6 +9,7 @@
     "extract-api": "yarn veramo dev extract-api"
   },
   "dependencies": {
+    "@transmute/did-key.js": "^0.2.1-unstable.35",
     "@veramo/core": "^1.0.1",
     "@veramo/did-manager": "^1.0.1",
     "debug": "^4.1.1",

diff --git a/packages/did-provider-key/src/index.ts b/packages/did-provider-key/src/index.ts
@@ -5,3 +5,4 @@
  * @packageDocumentation
  */
 export { KeyDIDProvider } from './key-did-provider'
+export { getDidKeyResolver } from './resolver'
diff --git a/packages/did-provider-key/src/resolver.ts b/packages/did-provider-key/src/resolver.ts
@@ -0,0 +1,25 @@
+import { resolver } from '@transmute/did-key.js'
+import { DIDDocument } from '@veramo/core'
+import { DIDResolutionOptions, DIDResolutionResult, DIDResolver, ParsedDID, Resolvable } from 'did-resolver'
+
+const resolve: DIDResolver = async (
+  didUrl: string,
+  _parsed: ParsedDID,
+  _resolver: Resolvable,
+  options: DIDResolutionOptions,
+): Promise<DIDResolutionResult> => {
+  try {
+    const didResolution = (await resolver.resolve(didUrl, options)) as DIDResolutionResult
+    return didResolution
+  } catch (err) {
+    return {
+      didDocumentMetadata: {},
+      didResolutionMetadata: { error: 'invalidDid', message: err.toString() },
+      didDocument: null,
+    }
+  }
+}
+
+export function getDidKeyResolver() {
+  return { key: resolve }
+}