uport-project / uport-did-resolver

DID resolver for uPort identities DEPRECATED

uPort DID Resolver

This library is intended to resolve uPort DID documents.

It supports the proposed Decentralized Identifiers spec from the W3C Credentials Community Group.

It requires the did-resolver library, which is the primary interface for resolving DIDs.

Resolving a DID document

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

import resolve from 'did-resolver'
import registerResolver from 'uport-did-resolver'

registerResolver()

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

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

uport-did-resolver's Issues

Incomplete dependencies

I tried using this lib in a Type Script project, but it complains

yarn tsc
yarn run v1.13.0
$ tsc
../../node_modules/uport-did-resolver/lib/register.d.ts:10:47 - error TS2304: Cannot find name 'UportLiteRegistry'.

10 export default function register(configured?: UportLiteRegistry): void;
                                                 ~~~~~~~~~~~~~~~~~


Found 2 errors.

error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

What I did to get past it was to add the interface to the node_module lib folder, meaning the compiled code:

import { DIDDocument } from 'did-resolver';
export declare interface LegacyUport {
    publicKey: string;
    publicEncKey?: string;
    name?: string;
    description?: string;
    image?: any;
}
---->
interface UportLiteRegistry {
    (mnid: string, callback: (error?: any , doc?: any) => void) : void
}
---->
export declare function convertToDid(did: string, legacy: LegacyUport): DIDDocument;
export default function register(configured?: UportLiteRegistry): void;

This stop the complaint and I could continue. But I think the problem is that the root vendor.d.ts file is never imported somehow, meaning that it acctually never knows its type.
Or any other idea?