- createClaimRequest
- createDelegateProof
- createIdentityProof
- createSelfSignedClaim
- deleteClaim
- getClaimById
- getClaimId
- getClaimsByIssuer
- getClaimsByRequester
- getClaimsBySubject
- getClaimsBySubjects
- getUserClaims
- hasOnChainRole
- init
- issueClaim
- issueClaimRequest
- publishPublicClaim
- registerOnchain
- rejectClaimRequest
- create
• new ClaimsService(_signerService
, _domainsService
, _cacheClient
, _didRegistry
)
Name | Type |
---|---|
_signerService |
SignerService |
_domainsService |
DomainsService |
_cacheClient |
CacheClient |
_didRegistry |
DidRegistry |
▸ createClaimRequest(__namedParameters
): Promise
<void
>
description
allows subject to request for credential
Name | Type |
---|---|
__namedParameters |
Object |
__namedParameters.claim |
Object |
__namedParameters.claim.claimType |
string |
__namedParameters.claim.claimTypeVersion |
number |
__namedParameters.claim.issuerFields? |
{ key : string ; value : string | number }[] |
__namedParameters.claim.requestorFields? |
{ key : string ; value : string | number }[] |
__namedParameters.registrationTypes? |
RegistrationTypes [] |
__namedParameters.subject? |
string |
Promise
<void
>
▸ createDelegateProof(delegateKey
, identity
, algorithm?
): Promise
<string
>
description
create a proof of identity delegate
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 |
- |
Promise
<string
>
token of delegate
▸ createIdentityProof(): Promise
<string
>
description
create a public claim to prove identity
Promise
<string
>
JWT token of created identity
▸ createSelfSignedClaim(__namedParameters
): Promise
<string
>
description
Creates claim with data
and adds it to subject
document. Signer must own or control subject
Name | Type |
---|---|
__namedParameters |
Object |
__namedParameters.data |
ClaimData |
__namedParameters.subject? |
string |
Promise
<string
>
claim url
▸ deleteClaim(__namedParameters
): Promise
<void
>
Name | Type |
---|---|
__namedParameters |
Object |
__namedParameters.id |
string |
Promise
<void
>
▸ getClaimById(claimId
): Promise
<undefined
| Claim
>
description
- Returns claim with the given Id or null if claim does not exist
Name | Type |
---|---|
claimId |
string |
Promise
<undefined
| Claim
>
▸ getClaimId(__namedParameters
): Promise
<string
>
Name | Type |
---|---|
__namedParameters |
Object |
__namedParameters.claimData |
ClaimData |
Promise
<string
>
▸ getClaimsByIssuer(__namedParameters
): Promise
<Claim
[]>
description
- Returns claims for given issuer. Allows filtering by status and parent namespace
Name | Type |
---|---|
__namedParameters |
Object |
__namedParameters.did |
string |
__namedParameters.isAccepted? |
boolean |
__namedParameters.namespace? |
string |
Promise
<Claim
[]>
▸ getClaimsByRequester(__namedParameters
): Promise
<Claim
[]>
description
- Returns claims for given requester. Allows filtering by status and parent namespace
Name | Type |
---|---|
__namedParameters |
Object |
__namedParameters.did |
string |
__namedParameters.isAccepted? |
boolean |
__namedParameters.namespace? |
string |
Promise
<Claim
[]>
▸ getClaimsBySubject(__namedParameters
): Promise
<Claim
[]>
description
- Returns claims for given subject. Allows filtering by status and parent namespace
Name | Type |
---|---|
__namedParameters |
Object |
__namedParameters.did |
string |
__namedParameters.isAccepted? |
boolean |
__namedParameters.namespace? |
string |
Promise
<Claim
[]>
▸ getClaimsBySubjects(subjects
): Promise
<Claim
[]>
Name | Type |
---|---|
subjects |
string [] |
Promise
<Claim
[]>
▸ getUserClaims(__namedParameters?
): Promise
<IServiceEndpoint
& ClaimData
[]>
getUserClaims
description
get published offchain claims
Name | Type |
---|---|
__namedParameters |
undefined | { did? : string } |
Promise
<IServiceEndpoint
& ClaimData
[]>
▸ 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
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 |
Promise
<boolean
>
true if DID has role at the version. false if not.
▸ init(): Promise
<void
>
Promise
<void
>
▸ issueClaim(__namedParameters
): Promise
<undefined
| string
>
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 |
Promise
<undefined
| string
>
▸ 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.
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 |
Promise
<void
>
▸ 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.
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 |
- |
Promise
<undefined
| string
>
ulr to ipfs
▸ registerOnchain(claim
): Promise
<void
>
description
Registers issued onchain claim with Claim manager
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 |
- |
Promise
<void
>
▸ rejectClaimRequest(__namedParameters
): Promise
<void
>
Name | Type |
---|---|
__namedParameters |
Object |
__namedParameters.id |
string |
__namedParameters.rejectionReason? |
string |
__namedParameters.requesterDID |
string |
Promise
<void
>
▸ Static
create(signerService
, domainsService
, cacheClient
, didRegistry
): Promise
<ClaimsService
>
Name | Type |
---|---|
signerService |
SignerService |
domainsService |
DomainsService |
cacheClient |
CacheClient |
didRegistry |
DidRegistry |
Promise
<ClaimsService
>