DidRegistry.md

Class: DidRegistry

Table of contents

Constructors

• constructor

Accessors

• ipfsStore
• jwt

Methods

• createDocument
• createPublicClaim
• decodeJWTToken
• getDidDelegates
• getDidDocument
• getDidPublicKeys
• init
• issuePublicClaim
• readServices
• revokeDidDocument
• updateDocument
• updateSignedDidDelegate
• updateSignedDidPublicKey
• verifyPublicClaim
• connect

Constructors

constructor

• new DidRegistry(_signerService, _cacheClient, _assetsService, _ipfsUrl?)

Parameters

Name	Type	Default value
_signerService	SignerService	undefined
_cacheClient	CacheClient	undefined
_assetsService	AssetsService	undefined
_ipfsUrl	string	'https://ipfs.infura.io:5001/api/v0/'

Accessors

ipfsStore

• get ipfsStore(): DidStore

Returns

DidStore

---

jwt

• get jwt(): JWT

Returns

JWT

Methods

createDocument

▸ createDocument(): Promise<boolean>

description create did document if not exists

Returns

Promise<boolean>

true if document is created successfully

---

createPublicClaim

▸ createPublicClaim(__namedParameters): Promise<string>

description create a public claim based on data provided

Parameters

Name	Type
__namedParameters	Object
__namedParameters.data	ClaimData
__namedParameters.subject?	string

Returns

Promise<string>

JWT token of created claim

---

decodeJWTToken

▸ decodeJWTToken(__namedParameters): Promise<unknown>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.token	string

Returns

Promise<unknown>

---

getDidDelegates

▸ getDidDelegates(__namedParameters): Promise<undefined | string[]>

description get public keys from DID's document

Parameters

Name	Type
__namedParameters	Object

Returns

Promise<undefined | string[]>

list of DID's delegates

---

getDidDocument

▸ getDidDocument(__namedParameters?): Promise<{ service: IServiceEndpoint & ClaimData[] }>

Parameters

Name	Type
__namedParameters	undefined | { did?: string ; includeClaims?: boolean }

Returns

Promise<{ service: IServiceEndpoint & ClaimData[] }>

---

getDidPublicKeys

▸ getDidPublicKeys(__namedParameters): Promise<IPublicKey[]>

description get public keys from User's DID document

Parameters

Name	Type
__namedParameters	Object

Returns

Promise<IPublicKey[]>

list of public keys

---

init

▸ init(): Promise<void>

Returns

Promise<void>

---

issuePublicClaim

▸ issuePublicClaim(__namedParameters): Promise<string>

description issue a public claim

Parameters

Name	Type
__namedParameters	Object
__namedParameters.publicClaim?	IPublicClaim
__namedParameters.token?	string

Returns

Promise<string>

return issued token

---

readServices

▸ readServices(__namedParameters?): Promise<IServiceEndpoint & ClaimData[]>

description gets list of services endpoints from User's DID document

Parameters

Name	Type
__namedParameters	undefined | { did?: string }

Returns

Promise<IServiceEndpoint & ClaimData[]>

list of claims

---

revokeDidDocument

▸ revokeDidDocument(): Promise<boolean>

description revokes did document

Returns

Promise<boolean>

information (true/false) if the DID document was revoked

---

updateDocument

▸ updateDocument(options): Promise<boolean>

description updates did document based on data provided

Parameters

Name	Type	Description
options	Object	Options to connect with blockchain
options.data	IUpdateData	New attribute value
options.did?	string	Asset did to be updated
options.didAttribute	DIDAttribute	Type of document to be updated
options.validity?	number	Time (s) for the attribute to expire

Returns

Promise<boolean>

true if document is updated successfuly

---

updateSignedDidDelegate

▸ updateSignedDidDelegate(__namedParameters): Promise<boolean>

description updates delegate of the document of controlled did

Parameters

Name	Type
__namedParameters	Object
__namedParameters.algo	KeyType
__namedParameters.delegatePublicKey	string
__namedParameters.did	string
__namedParameters.type	PubKeyType
__namedParameters.validity?	number

Returns

Promise<boolean>

true if document is updated successfuly

---

updateSignedDidPublicKey

▸ updateSignedDidPublicKey(__namedParameters): Promise<boolean>

description Adds public key to the document of controlled did

Parameters

Name	Type
__namedParameters	Object
__namedParameters.algo	KeyType
__namedParameters.did	string
__namedParameters.publicKey	string
__namedParameters.tag	string
__namedParameters.type	PubKeyType
__namedParameters.validity?	number

Returns

Promise<boolean>

true if document is updated successfuly

---

verifyPublicClaim

▸ verifyPublicClaim(token, iss): Promise<null | string>

description verifies issued token of claim

Parameters

Name	Type
token	string
iss	string

Returns

Promise<null | string>

public claim data

---

connect

▸ Static connect(signerService, cacheClient, assetsService, ipfsUrl?): Promise<DidRegistry>

Parameters

Name	Type
signerService	SignerService
cacheClient	CacheClient
assetsService	AssetsService
ipfsUrl?	string

Returns

Promise<DidRegistry>