dids v5.0.2

DID

A simple library to interact with DIDs that conform to the DID-provider interface.

Installation

npm install dids

Examples

Authentication with the provider

import { DID } from 'dids'
import IdentityWallet from 'identity-wallet'

// See https://github.com/3box/identity-wallet-js
const wallet = new IdentityWallet(...)
const alice = new DID({ provider: wallet.getDidProvider() })

// Authenticate with the provider
await alice.authenticate()

// Read the DID string - this will throw an error if the DID instance is not authenticated
const aliceDID = alice.DID

// Create a JWS - this will throw an error if the DID instance is not authenticated
const jws = await alice.createJWS({ hello: 'world' })

// Create a DagJWS - the payload will be encoded as ipld dag-cbor, the resulting JWS is dag-jose compatible
const { jws, linkedBlock } = await alice.createJWS({ hello: 'world' coolLink: new CID(...) })

Resolving DIDs

import { DID } from 'dids'

// See https://github.com/decentralized-identity/did-resolver
const registry = { test: myTestResolver }
const did = new DID({ resolver: { registry } })

// Resolve a DID document
await did.resolve('did:test:...')

Interfaces and types

DIDDocument

The DID document interface, as defined in the DID resolver library.

DIDProvider

The DID provider interface, an alias for RPCConnection.

AuthenticateOptions

interface AuthenticateOptions {
  provider?: DIDProvider
}

CreateJWSOptions

interface CreateJWSOptions {
  did?: string
  protected?: Record<string, any>
}

DagJWSResult

interface DagJWSResult {
  jws: string // base64-encoded
  linkedBlock: string // base64-encoded
}

ResolverRegistry

A record of DID methods to resolvers, as defined in the DID resolver library.

export type ResolverRegistry = Record<string, DIDResolver>

ResolverOptions

Options used to create a Resolver instance, as defined in the DID resolver library.

export interface ResolverOptions {
  registry?: ResolverRegistry
  cache?: DIDCache | boolean
}

DIDOptions

export interface DIDOptions {
  provider?: DIDProvider
  resolver?: Resolver | ResolverOptions
}

API

DID class

constructor

Arguments

1. options?: DIDOptions

did.authenticated

Returns boolean

did.id

Accessing this property will throw an error if the instance is not authenticated

Returns string

did.setProvider()

Calling this method will throw an error if a different provider is already set

Arguments

1. provider: DIDProvider

Returns void

did.setResolver()

Arguments

1. resolver: Resolver | ResolverOptions

Returns void

did.authenticate()

Calling this method with a provider will throw an error if a different provider is already set

Arguments

1. options?: AuthenticateOptions

Returns Promise<string>

did.createJWS()

The instance needs to be authenticated before calling this method

Arguments

1. payload: Record<string, any>
2. options?: CreateJWSOptions to specify the protected header

Returns Promise<string>

did.createDagJWS()

Creates a JWS that is compatible with dag-jose.

The instance needs to be authenticated before calling this method

Arguments

1. payload: Record<string, any>
2. options?: CreateJWSOptions to specify the protected header, and did with keyFragment

Returns Promise<DagJWSResult>

did.resolve()

Arguments

1. didUrl: string

Returns Promise<DIDDocument>

License

MIT