modules_didRegistry_didRegistry_service.DidRegistry.md

Class: DidRegistry

modules/didRegistry/didRegistry.service.DidRegistry

Table of contents

Constructors

• constructor

Accessors

• ipfsStore
• jwt

Methods

• createDocument
• createPublicClaim
• decodeJWTToken
• getDidDocument
• init
• issuePublicClaim
• revokeDidDocument
• updateDocument
• 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>

createPublicClaim

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>

---

getDidDocument

▸ getDidDocument(__namedParameters?): Promise<Object>

Parameters

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

Returns

Promise<Object>

---

init

▸ init(): Promise<void>

Returns

Promise<void>

---

issuePublicClaim

▸ issuePublicClaim(__namedParameters): Promise<string>

issuePublicClaim

description issue a public claim

Parameters

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

Returns

Promise<string>

return issued token

---

revokeDidDocument

▸ revokeDidDocument(): Promise<boolean>

revokeDidDocument

description revokes did document

Returns

Promise<boolean>

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

---

updateDocument

▸ updateDocument(__namedParameters): Promise<boolean>

description updates did document based on data provided

Parameters

Name	Type
__namedParameters	Object
__namedParameters.data	IUpdateData
__namedParameters.did?	string
__namedParameters.didAttribute	DIDAttribute
__namedParameters.validity?	number

Returns

Promise<boolean>

true if document is updated successfuly

---

verifyPublicClaim

▸ verifyPublicClaim(token, iss): Promise<boolean>

verifyPublicClaim

description verifies issued token of claim

Parameters

Name	Type
token	string
iss	string

Returns

Promise<boolean>

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>