feat: add claim revocation

energywebfoundation · May 24, 2022 · 2ab1d93 · 2ab1d93
1 parent 4e4b279
commit 2ab1d93
Show file tree

Hide file tree

Showing 28 changed files with 18,453 additions and 4,754 deletions.
diff --git a/docs/api/classes/modules_cache_client.CacheClient.md b/docs/api/classes/modules_cache_client.CacheClient.md
@@ -592,7 +592,7 @@ ___
 
 ### getRoleDefinition
 
-▸ **getRoleDefinition**(`namespace`): `Promise`<`IRoleDefinition`\>
+▸ **getRoleDefinition**(`namespace`): `Promise`<`IRoleDefinition` \| `IRoleDefinitionV2`\>
 
 #### Parameters
 
@@ -602,7 +602,7 @@ ___
 
 #### Returns
 
-`Promise`<`IRoleDefinition`\>
+`Promise`<`IRoleDefinition` \| `IRoleDefinitionV2`\>
 
 #### Implementation of
 

diff --git a/docs/api/classes/modules_claims.ClaimsService.md b/docs/api/classes/modules_claims.ClaimsService.md
@@ -20,6 +20,7 @@ claimsService.getClaimById(claim.id);
 
 ### Methods
 
+- [claimRevocationDetails](modules_claims.ClaimsService.md#claimrevocationdetails)
 - [createClaimRequest](modules_claims.ClaimsService.md#createclaimrequest)
 - [createDelegateProof](modules_claims.ClaimsService.md#createdelegateproof)
 - [createIdentityProof](modules_claims.ClaimsService.md#createidentityproof)
@@ -35,11 +36,14 @@ claimsService.getClaimById(claim.id);
 - [getUserClaims](modules_claims.ClaimsService.md#getuserclaims)
 - [hasOnChainRole](modules_claims.ClaimsService.md#hasonchainrole)
 - [init](modules_claims.ClaimsService.md#init)
+- [isClaimRevoked](modules_claims.ClaimsService.md#isclaimrevoked)
 - [issueClaim](modules_claims.ClaimsService.md#issueclaim)
 - [issueClaimRequest](modules_claims.ClaimsService.md#issueclaimrequest)
 - [publishPublicClaim](modules_claims.ClaimsService.md#publishpublicclaim)
 - [registerOnchain](modules_claims.ClaimsService.md#registeronchain)
 - [rejectClaimRequest](modules_claims.ClaimsService.md#rejectclaimrequest)
+- [revokeClaim](modules_claims.ClaimsService.md#revokeclaim)
+- [revokeMultipleClaim](modules_claims.ClaimsService.md#revokemultipleclaim)
 - [create](modules_claims.ClaimsService.md#create)
 
 ## Constructors
@@ -60,6 +64,41 @@ claimsService.getClaimById(claim.id);
 
 ## Methods
 
+### claimRevocationDetails
+
+▸ **claimRevocationDetails**(`options`): `Promise`<`undefined` \| [`ClaimRevocationDetailsResult`](../interfaces/modules_claims.ClaimRevocationDetailsResult.md)\>
+
+Get the revocation details for a subject's On-Chain claim. Returns the revoker and revocationTimeStamp for the revocation.
+
+```typescript
+claimsService.claimRevocationDetails({
+    claim: {
+        namespace: 'root.roles.energyweb.iam.ewc',
+        subject: 'did:ethr:volta:0x00...0',
+    },
+});
+```
+or
+```typescript
+claimsService.claimRevocationDetails({
+    claimId: claim.id,
+});
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | [`ClaimRevocationDetailsOptions`](../interfaces/modules_claims.ClaimRevocationDetailsOptions.md) | object containing options |
+
+#### Returns
+
+`Promise`<`undefined` \| [`ClaimRevocationDetailsResult`](../interfaces/modules_claims.ClaimRevocationDetailsResult.md)\>
+
+revocation details
+
+___
+
 ### createClaimRequest
 
 ▸ **createClaimRequest**(`options`): `Promise`<`void`\>
@@ -436,6 +475,41 @@ ___
 
 ___
 
+### isClaimRevoked
+
+▸ **isClaimRevoked**(`options`): `Promise`<`boolean`\>
+
+Check if On-Chain claim is revoked.
+
+```typescript
+claimsService.isClaimRevoked({
+    claim: {
+        namespace: 'root.roles.energyweb.iam.ewc',
+        subject: 'did:ethr:volta:0x00...0',
+    },
+});
+```
+or
+```typescript
+claimsService.isClaimRevoked({
+    claimId: claim.id,
+});
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | [`IsClaimRevokedOptions`](../interfaces/modules_claims.IsClaimRevokedOptions.md) | object containing options |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+true if claim is revoked
+
+___
+
 ### issueClaim
 
 ▸ **issueClaim**(`options`): `Promise`<`undefined` \| `string`\>
@@ -589,6 +663,83 @@ claimsService.rejectClaimRequest({
 
 ___
 
+### revokeClaim
+
+▸ **revokeClaim**(`options`): `Promise`<`boolean`\>
+
+Revoke On-Chain issued claim by `claimId` or given `namespace` and `subject`. Required `claimId` or `claim` parameters.
+
+```typescript
+claimsService.revokeClaim({
+    claim: {
+        namespace: 'root.roles.energyweb.iam.ewc',
+        subject: 'did:ethr:volta:0x00...0',
+    },
+    registrationTypes = [RegistrationTypes.OnChain, RegistrationTypes.OffChain],
+});
+```
+or
+```typescript
+claimsService.revokeClaim({
+    claimId: claim.id,
+    registrationTypes = [RegistrationTypes.OnChain, RegistrationTypes.OffChain],
+});
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | [`RevokeClaimOptions`](../interfaces/modules_claims.RevokeClaimOptions.md) | object containing options |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+true if claim was revoked
+
+___
+
+### revokeMultipleClaim
+
+▸ **revokeMultipleClaim**(`options`): `Promise`<`void`\>
+
+Revoke On-Chain issued claims of the given namespace for multiple subjects. Namespace must be the same for all subjects.
+Specify `claims` or `claimIds` parameters.
+
+```typescript
+claimsService.revokeMultipleClaim({
+    claims: [{
+        namespace: 'root.roles.energyweb.iam.ewc',
+        subject: 'did:ethr:volta:0x00...0',
+        registrationTypes = [RegistrationTypes.OnChain, RegistrationTypes.OffChain],
+    },
+    {
+        namespace: 'root.roles.energyweb.iam.ewc',
+        subject: 'did:ethr:volta:0x00...1',
+        registrationTypes = [RegistrationTypes.OnChain],
+    }],
+});
+```
+or
+```typescript
+claimsService.revokeMultipleClaim({
+    claimIds: ['245a40a9...776071ca57cec', '245a40a9...776071ca57cec'],
+});
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | [`RevokeMultipleClaimOptions`](../interfaces/modules_claims.RevokeMultipleClaimOptions.md) | object containing options |
+
+#### Returns
+
+`Promise`<`void`\>
+
+___
+
 ### create
 
 ▸ `Static` **create**(`signerService`, `domainsService`, `cacheClient`, `didRegistry`, `verifiableCredentialService`): `Promise`<[`ClaimsService`](modules_claims.ClaimsService.md)\>

diff --git a/docs/api/classes/modules_did_registry.DidRegistry.md b/docs/api/classes/modules_did_registry.DidRegistry.md
@@ -20,6 +20,7 @@ didRegistry.getDidDocument();
 
 ### Accessors
 
+- [identityOwner](modules_did_registry.DidRegistry.md#identityowner)
 - [ipfsStore](modules_did_registry.DidRegistry.md#ipfsstore)
 - [jwt](modules_did_registry.DidRegistry.md#jwt)
 
@@ -58,6 +59,16 @@ didRegistry.getDidDocument();
 
 ## Accessors
 
+### identityOwner
+
+• `get` **identityOwner**(): `EwSigner`
+
+#### Returns
+
+`EwSigner`
+
+___
+
 ### ipfsStore
 
 • `get` **ipfsStore**(): `DidStore`

diff --git a/docs/api/classes/modules_domains.DomainsService.md b/docs/api/classes/modules_domains.DomainsService.md
@@ -428,7 +428,7 @@ ___
 
 ### getDefinition
 
-▸ **getDefinition**(`options`): `Promise`<`IRoleDefinition` \| `IOrganizationDefinition` \| `IAppDefinition`\>
+▸ **getDefinition**(`options`): `Promise`<`IRoleDefinition` \| `IOrganizationDefinition` \| `IAppDefinition` \| `IRoleDefinitionV2`\>
 
 Fetch cached domain definition for organization, application or role.
 
@@ -447,7 +447,7 @@ domainsService.getDefinition({
 
 #### Returns
 
-`Promise`<`IRoleDefinition` \| `IOrganizationDefinition` \| `IAppDefinition`\>
+`Promise`<`IRoleDefinition` \| `IOrganizationDefinition` \| `IAppDefinition` \| `IRoleDefinitionV2`\>
 
 domain definition
 

diff --git a/docs/api/interfaces/modules_claims.ClaimRevocationDetailsOptions.md b/docs/api/interfaces/modules_claims.ClaimRevocationDetailsOptions.md
@@ -0,0 +1,31 @@
+# Interface: ClaimRevocationDetailsOptions
+
+[modules/claims](../modules/modules_claims.md).ClaimRevocationDetailsOptions
+
+## Table of contents
+
+### Properties
+
+- [claim](modules_claims.ClaimRevocationDetailsOptions.md#claim)
+- [claimId](modules_claims.ClaimRevocationDetailsOptions.md#claimid)
+
+## Properties
+
+### claim
+
+• `Optional` **claim**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `namespace` | `string` | Claim type namespace |
+| `subject` | `string` | Subject of the claim |
+
+___
+
+### claimId
+
+• `Optional` **claimId**: `string`
+
+Claim id
diff --git a/docs/api/interfaces/modules_claims.ClaimRevocationDetailsResult.md b/docs/api/interfaces/modules_claims.ClaimRevocationDetailsResult.md
@@ -0,0 +1,22 @@
+# Interface: ClaimRevocationDetailsResult
+
+[modules/claims](../modules/modules_claims.md).ClaimRevocationDetailsResult
+
+## Table of contents
+
+### Properties
+
+- [revoker](modules_claims.ClaimRevocationDetailsResult.md#revoker)
+- [timestamp](modules_claims.ClaimRevocationDetailsResult.md#timestamp)
+
+## Properties
+
+### revoker
+
+• **revoker**: `string`
+
+___
+
+### timestamp
+
+• **timestamp**: `number`
diff --git a/docs/api/interfaces/modules_claims.GetRevocationClaimDetailsOptions.md b/docs/api/interfaces/modules_claims.GetRevocationClaimDetailsOptions.md
@@ -0,0 +1,31 @@
+# Interface: GetRevocationClaimDetailsOptions
+
+[modules/claims](../modules/modules_claims.md).GetRevocationClaimDetailsOptions
+
+## Table of contents
+
+### Properties
+
+- [claim](modules_claims.GetRevocationClaimDetailsOptions.md#claim)
+- [claimId](modules_claims.GetRevocationClaimDetailsOptions.md#claimid)
+
+## Properties
+
+### claim
+
+• `Optional` **claim**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `namespace` | `string` | Claim type namespace |
+| `subject` | `string` | Subject of the claim |
+
+___
+
+### claimId
+
+• `Optional` **claimId**: `string`
+
+Claim id
diff --git a/docs/api/interfaces/modules_claims.GetRevocationClaimDetailsResult.md b/docs/api/interfaces/modules_claims.GetRevocationClaimDetailsResult.md
@@ -0,0 +1,22 @@
+# Interface: GetRevocationClaimDetailsResult
+
+[modules/claims](../modules/modules_claims.md).GetRevocationClaimDetailsResult
+
+## Table of contents
+
+### Properties
+
+- [namespace](modules_claims.GetRevocationClaimDetailsResult.md#namespace)
+- [subject](modules_claims.GetRevocationClaimDetailsResult.md#subject)
+
+## Properties
+
+### namespace
+
+• **namespace**: `string`
+
+___
+
+### subject
+
+• **subject**: `string`
diff --git a/docs/api/interfaces/modules_claims.IsClaimRevokedOptions.md b/docs/api/interfaces/modules_claims.IsClaimRevokedOptions.md
@@ -0,0 +1,31 @@
+# Interface: IsClaimRevokedOptions
+
+[modules/claims](../modules/modules_claims.md).IsClaimRevokedOptions
+
+## Table of contents
+
+### Properties
+
+- [claim](modules_claims.IsClaimRevokedOptions.md#claim)
+- [claimId](modules_claims.IsClaimRevokedOptions.md#claimid)
+
+## Properties
+
+### claim
+
+• `Optional` **claim**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `namespace` | `string` | Claim type namespace |
+| `subject` | `string` | Subject of the claim |
+
+___
+
+### claimId
+
+• `Optional` **claimId**: `string`
+
+Claim id