ClaimsService.md

Class: ClaimsService

Table of contents

Constructors

• constructor

Methods

• createClaimRequest
• createDelegateProof
• createIdentityProof
• createSelfSignedClaim
• deleteClaim
• getClaimById
• getClaimId
• getClaimsByIssuer
• getClaimsByRequester
• getClaimsBySubject
• getClaimsBySubjects
• getUserClaims
• hasOnChainRole
• init
• issueClaim
• issueClaimRequest
• publishPublicClaim
• registerOnchain
• rejectClaimRequest
• create

Constructors

constructor

• new ClaimsService(_signerService, _domainsService, _cacheClient, _didRegistry)

Parameters

Name	Type
_signerService	SignerService
_domainsService	DomainsService
_cacheClient	CacheClient
_didRegistry	DidRegistry

Methods

createClaimRequest

▸ createClaimRequest(__namedParameters): Promise<void>

description allows subject to request for credential

field { claim: fields } - @deprecated - use requestorFields instead

Parameters

Name	Type
__namedParameters	Object
__namedParameters.claim	Object
__namedParameters.claim.claimType	string
__namedParameters.claim.claimTypeVersion	number
__namedParameters.claim.fields?	{ key: string ; value: string | number }[]
__namedParameters.claim.issuerFields?	{ key: string ; value: string | number }[]
__namedParameters.claim.requestorFields?	{ key: string ; value: string | number }[]
__namedParameters.registrationTypes?	RegistrationTypes[]
__namedParameters.subject?	string

Returns

Promise<void>

---

createDelegateProof

▸ createDelegateProof(delegateKey, identity, algorithm?): Promise<string>

description create a proof of identity delegate

Parameters

Name	Type	Default value	Description
delegateKey	string	undefined	private key of the delegate in hexadecimal format
identity	string	undefined	Did of the delegate
algorithm	Algorithms	Algorithms.EIP191	-

Returns

Promise<string>

token of delegate

---

createIdentityProof

▸ createIdentityProof(): Promise<string>

description create a public claim to prove identity

Returns

Promise<string>

JWT token of created identity

---

createSelfSignedClaim

▸ createSelfSignedClaim(__namedParameters): Promise<string>

description Creates claim with data and adds it to subject document. Signer must own or control subject

Parameters

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

Returns

Promise<string>

claim url

---

deleteClaim

▸ deleteClaim(__namedParameters): Promise<void>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.id	string

Returns

Promise<void>

---

getClaimById

▸ getClaimById(claimId): Promise<undefined | Claim>

description - Returns claim with the given Id or null if claim does not exist

Parameters

Name	Type
claimId	string

Returns

Promise<undefined | Claim>

---

getClaimId

▸ getClaimId(__namedParameters): Promise<string>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.claimData	ClaimData

Returns

Promise<string>

---

getClaimsByIssuer

▸ getClaimsByIssuer(__namedParameters): Promise<Claim[]>

description - Returns claims for given issuer. Allows filtering by status and parent namespace

Parameters

Name	Type
__namedParameters	Object
__namedParameters.did	string
__namedParameters.isAccepted?	boolean
__namedParameters.namespace?	string

Returns

Promise<Claim[]>

---

getClaimsByRequester

▸ getClaimsByRequester(__namedParameters): Promise<Claim[]>

description - Returns claims for given requester. Allows filtering by status and parent namespace

Parameters

Name	Type
__namedParameters	Object
__namedParameters.did	string
__namedParameters.isAccepted?	boolean
__namedParameters.namespace?	string

Returns

Promise<Claim[]>

---

getClaimsBySubject

▸ getClaimsBySubject(__namedParameters): Promise<Claim[]>

description - Returns claims for given subject. Allows filtering by status and parent namespace

Parameters

Name	Type
__namedParameters	Object
__namedParameters.did	string
__namedParameters.isAccepted?	boolean
__namedParameters.namespace?	string

Returns

Promise<Claim[]>

---

getClaimsBySubjects

▸ getClaimsBySubjects(subjects): Promise<Claim[]>

Parameters

Name	Type
subjects	string[]

Returns

Promise<Claim[]>

---

getUserClaims

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

getUserClaims

description get user claims

Parameters

Name	Type
__namedParameters	undefined | { did?: string }

Returns

Promise<IServiceEndpoint & ClaimData[]>

---

hasOnChainRole

▸ hasOnChainRole(did, role, version): Promise<boolean>

A utility function to check the blockchain directly if a DID has a role TODO: fail if the DID chain ID doesn't match the configured signer network connect

Parameters

Name	Type	Description
did	string	The ethr DID to check
role	string	The role to check (the full namespace)
version	number	The version to check

Returns

Promise<boolean>

true if DID has role at the version. false if not.

---

init

▸ init(): Promise<void>

Returns

Promise<void>

---

issueClaim

▸ issueClaim(__namedParameters): Promise<undefined | string>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.claim	Object
__namedParameters.claim.claimType	string
__namedParameters.claim.claimTypeVersion	number
__namedParameters.claim.issuerFields	{ key: string ; value: string | number }[]
__namedParameters.registrationTypes	RegistrationTypes[]
__namedParameters.subject	string

Returns

Promise<undefined | string>

---

issueClaimRequest

▸ issueClaimRequest(__namedParameters): Promise<void>

Issue a claim request by signing both off-chain and on-chain request and persisting result to the cache-server. Optionally, issue on-chain role can be submitted to the ClaimManager contract as well.

Parameters

Name	Type
__namedParameters	Object
__namedParameters.id	string
__namedParameters.issuerFields?	{ key: string ; value: string | number }[]
__namedParameters.publishOnChain?	boolean
__namedParameters.registrationTypes	RegistrationTypes[]
__namedParameters.requester	string
__namedParameters.subjectAgreement	string
__namedParameters.token	string

Returns

Promise<void>

---

publishPublicClaim

▸ publishPublicClaim(token): Promise<undefined | string>

description publishes claim off-chain (by storing claim data in ipfs and save url to DID document services) or registering on-chain depending on registrationTypes values.

Parameters

Name	Type	Description
token	Object	@deprecated - use claim with claimType instead
token.claim	Object	-
token.claim.claimType?	string	-
token.claim.token?	string	-
token.registrationTypes?	RegistrationTypes[]	-
token.token?	string	-

Returns

Promise<undefined | string>

ulr to ipfs

---

registerOnchain

▸ registerOnchain(claim): Promise<void>

description Registers issued onchain claim with Claim manager

Parameters

Name	Type	Description
claim	Object	id of signed onchain claim.
claim.acceptedBy	string	-
claim.claimType?	string	-
claim.claimTypeVersion?	string	-
claim.onChainProof	string	-
claim.subject?	string	-
claim.subjectAgreement?	string	-
claim.token?	string	-

Returns

Promise<void>

---

rejectClaimRequest

▸ rejectClaimRequest(__namedParameters): Promise<void>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.id	string
__namedParameters.rejectionReason?	string
__namedParameters.requesterDID	string

Returns

Promise<void>

---

create

▸ Static create(signerService, domainsService, cacheClient, didRegistry): Promise<ClaimsService>

Parameters

Name	Type
signerService	SignerService
domainsService	DomainsService
cacheClient	CacheClient
didRegistry	DidRegistry

Returns

Promise<ClaimsService>