Skip to content
Generic did-resolver
TypeScript
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src fix space Sep 1, 2019
.gitignore microbundled implementation Apr 1, 2019
.prettierrc fix tslint Sep 1, 2019
LICENSE Relicense to Apache 2.0 Mar 31, 2019
README.md Update import Resolver key to match the library export key Sep 16, 2019
package-lock.json bump ts Sep 1, 2019
package.json bump ts Sep 1, 2019
tsconfig.json microbundled implementation Apr 1, 2019
tslint.json fix tslint Sep 1, 2019

README.md

Javascript DID Resolver

This library is intended as a simple common interface for javascript applications to resolve DID documents from Decentralized Identifiers (DIDs).

This is intended to support the proposed Decentralized Identifiers spec from the W3C Credentials Community Group.

The library does not implement any specific DID method, but allows DID method implementors to release npm packages that applications can add.

Breaking changes (0.1.0)

This removes the global resolver. We've learnt that this ended up causing many problems. Instead you should now instantiate a Resolver object and use that to resolve did's within your consuming app/library.

Changes required for developers of DID resolvers

You now no longer register your DID resolvers using the global registerMethod() function. Instead export the resolver function and show how to configure it in a local resolver object.

Configure Resolver object

You are now required to preconfigure a resolver during instantiation:

import { Resolver } from 'did-resolver'
import ethr from 'ethr-did-resolver'
import web from 'web-did-resolver'
import sov from 'sov-did-resolver'

const resolver = new Resolver({
  ethr,
  web,
  https: web // Override a did method type
})

Resolving a DID document

The resolver presents a simple resolve() function that returns a ES6 Promise returning the DID document.

resolver.resolve('did:uport:2nQtiQG6Cgm1GYTBaaKAgr76uY7iSexUkqX/some/path#fragment=123').then(doc => console.log)

// You can also use ES7 async/await syntax
const doc = await resolver.resolve('did:uport:2nQtiQG6Cgm1GYTBaaKAgr76uY7iSexUkqX/some/path#fragment=123')

Implementing a DID method

Each DID method will have it's own methods for looking up an identifier on it's respective blockchain or other decentralized storage mechanism.

A method implementer calls the registerMethod('methodname', resolver). where methodname is the method identifier. The resolver is a function that receives a DID and a parsed version of the DID. It returns a ES6 Promise that looks up the DID document.

export default async function myResolver (did, parsed, didResolver) {
  console.log(parsed)
  // {method: 'mymethod', id: 'abcdefg', did: 'did:mymethod:abcdefg/some/path#fragment=123', path: '/some/path', fragment: 'fragment=123'}
  const didDoc = ...// lookup doc
  // If you need to lookup another did as part of resolving this did document, the primary DIDResolver object is passed in as well
  const parentDID = await didResolver.resolve(...)
  //
  return didDoc
})

The method resolver should register this so that just requiring it will register the method:

import { DIDResolver } from 'did-resolver'
import MyMethod from 'mymethod-did-resolver'

const resolver = new DIDResolver({
  mymethod: MyMethod
})
You can’t perform that action at this time.