Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(verifyVC): add verifyVC method to Claims Service #592

Merged
merged 15 commits into from
Jul 13, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions docs/api/classes/modules_claims.ClaimsService.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,11 @@ claimsService.getClaimById(claim.id);
- [publishPublicClaim](modules_claims.ClaimsService.md#publishpublicclaim)
- [registerOnchain](modules_claims.ClaimsService.md#registeronchain)
- [rejectClaimRequest](modules_claims.ClaimsService.md#rejectclaimrequest)
- [resolveCredentialAndVerify](modules_claims.ClaimsService.md#resolvecredentialandverify)
- [revokeClaim](modules_claims.ClaimsService.md#revokeclaim)
- [revokeMultipleClaim](modules_claims.ClaimsService.md#revokemultipleclaim)
- [verifyOffChainClaim](modules_claims.ClaimsService.md#verifyoffchainclaim)
- [verifyVc](modules_claims.ClaimsService.md#verifyvc)
- [create](modules_claims.ClaimsService.md#create)

## Constructors
Expand Down Expand Up @@ -691,6 +694,27 @@ claimsService.rejectClaimRequest({

___

### resolveCredentialAndVerify

▸ **resolveCredentialAndVerify**(`subjectDID`, `roleNamespace`): `Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\>

Resolve a credential from storage and verify its proof/signature and its issuer's authority

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `subjectDID` | `string` | The DID to try to resolve a credential for |
| `roleNamespace` | `string` | - |

#### Returns

`Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\>

void. Returns "Proof Not Verified" error if VC not verified. Returns error if issuer not verified

___

### revokeClaim

▸ **revokeClaim**(`options`): `Promise`<`boolean`\>
Expand Down Expand Up @@ -768,6 +792,51 @@ claimsService.revokeMultipleClaim({

___

### verifyOffChainClaim

▸ **verifyOffChainClaim**(`subjectDID`, `roleNamespace`): `Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\>

Verifies:
- That off-chain claim was issued by authorized issuer
- That off-chain claim proof is valid

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `subjectDID` | `string` | The DID to try to resolve a credential for |
| `roleNamespace` | `string` | - |

#### Returns

`Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\>

Boolean indicating if verified and array of error messages

___

### verifyVc

▸ **verifyVc**(`vc`): `Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\>

Verifies:
- That credential proof is valid
- That credential was issued by authorized issuer

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `vc` | `VerifiableCredential`<`RoleCredentialSubject`\> | to be verified |

#### Returns

`Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\>

Boolean indicating if verified and array of error messages

___

### create

▸ `Static` **create**(`signerService`, `domainsService`, `cacheClient`, `didRegistry`, `verifiableCredentialService`): `Promise`<[`ClaimsService`](modules_claims.ClaimsService.md)\>
Expand Down
8 changes: 4 additions & 4 deletions docs/api/classes/modules_domains.DomainsService.md
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ ___

### getDefinition

▸ **getDefinition**(`options`): `Promise`<`IRoleDefinition` \| `IRoleDefinitionV2` \| `IOrganizationDefinition` \| `IAppDefinition`\>
▸ **getDefinition**(`options`): `Promise`<`IRoleDefinition` \| `IOrganizationDefinition` \| `IAppDefinition` \| `IRoleDefinitionV2`\>

Fetch cached domain definition for organization, application or role.

Expand All @@ -486,15 +486,15 @@ domainsService.getDefinition({

#### Returns

`Promise`<`IRoleDefinition` \| `IRoleDefinitionV2` \| `IOrganizationDefinition` \| `IAppDefinition`\>
`Promise`<`IRoleDefinition` \| `IOrganizationDefinition` \| `IAppDefinition` \| `IRoleDefinitionV2`\>

domain definition

___

### getENSTypesByOwner

▸ **getENSTypesByOwner**(`options`): `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[] \| [`IRole`](../interfaces/modules_domains.IRole.md)[] \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\>
▸ **getENSTypesByOwner**(`options`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[] \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md)[] \| [`IApp`](../interfaces/modules_domains.IApp.md)[]\>

Get all organization/application/role for certain owner.

Expand All @@ -514,7 +514,7 @@ domainsService.getENSTypesByOwner({

#### Returns

`Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[] \| [`IRole`](../interfaces/modules_domains.IRole.md)[] \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\>
`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[] \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md)[] \| [`IApp`](../interfaces/modules_domains.IApp.md)[]\>

array of organizations/applications/roles for certain owner

Expand Down
14 changes: 7 additions & 7 deletions docs/api/enums/modules_assets.AssetHistoryEventType.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,40 @@

## Table of contents

### Enumeration Members
### Enumeration members

- [ASSET\_CREATED](modules_assets.AssetHistoryEventType.md#asset_created)
- [ASSET\_OFFERED](modules_assets.AssetHistoryEventType.md#asset_offered)
- [ASSET\_OFFER\_CANCELED](modules_assets.AssetHistoryEventType.md#asset_offer_canceled)
- [ASSET\_OFFER\_REJECTED](modules_assets.AssetHistoryEventType.md#asset_offer_rejected)
- [ASSET\_TRANSFERRED](modules_assets.AssetHistoryEventType.md#asset_transferred)

## Enumeration Members
## Enumeration members

### ASSET\_CREATED

• **ASSET\_CREATED**
• **ASSET\_CREATED** = `"ASSET_CREATED"`

___

### ASSET\_OFFERED

• **ASSET\_OFFERED**
• **ASSET\_OFFERED** = `"ASSET_OFFERED"`

___

### ASSET\_OFFER\_CANCELED

• **ASSET\_OFFER\_CANCELED**
• **ASSET\_OFFER\_CANCELED** = `"ASSET_OFFER_CANCELED"`

___

### ASSET\_OFFER\_REJECTED

• **ASSET\_OFFER\_REJECTED**
• **ASSET\_OFFER\_REJECTED** = `"ASSET_OFFER_REJECTED"`

___

### ASSET\_TRANSFERRED

• **ASSET\_TRANSFERRED**
• **ASSET\_TRANSFERRED** = `"ASSET_TRANSFERRED"`
8 changes: 4 additions & 4 deletions docs/api/enums/modules_cache_client.Order.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

## Table of contents

### Enumeration Members
### Enumeration members

- [ASC](modules_cache_client.Order.md#asc)
- [DESC](modules_cache_client.Order.md#desc)

## Enumeration Members
## Enumeration members

### ASC

• **ASC**
• **ASC** = `"ASC"`

___

### DESC

• **DESC**
• **DESC** = `"DESC"`
10 changes: 5 additions & 5 deletions docs/api/enums/modules_cache_client.SearchType.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@

## Table of contents

### Enumeration Members
### Enumeration members

- [App](modules_cache_client.SearchType.md#app)
- [Org](modules_cache_client.SearchType.md#org)
- [Role](modules_cache_client.SearchType.md#role)

## Enumeration Members
## Enumeration members

### App

• **App**
• **App** = `"App"`

___

### Org

• **Org**
• **Org** = `"Org"`

___

### Role

• **Role**
• **Role** = `"Role"`
10 changes: 5 additions & 5 deletions docs/api/enums/modules_claims.ClaimEventType.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@

## Table of contents

### Enumeration Members
### Enumeration members

- [ISSUE\_CREDENTIAL](modules_claims.ClaimEventType.md#issue_credential)
- [REJECT\_CREDENTIAL](modules_claims.ClaimEventType.md#reject_credential)
- [REQUEST\_CREDENTIALS](modules_claims.ClaimEventType.md#request_credentials)

## Enumeration Members
## Enumeration members

### ISSUE\_CREDENTIAL

• **ISSUE\_CREDENTIAL**
• **ISSUE\_CREDENTIAL** = `"issue-credential"`

___

### REJECT\_CREDENTIAL

• **REJECT\_CREDENTIAL**
• **REJECT\_CREDENTIAL** = `"reject-credential"`

___

### REQUEST\_CREDENTIALS

• **REQUEST\_CREDENTIALS**
• **REQUEST\_CREDENTIALS** = `"request-credential"`
8 changes: 4 additions & 4 deletions docs/api/enums/modules_claims.RegistrationTypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

## Table of contents

### Enumeration Members
### Enumeration members

- [OffChain](modules_claims.RegistrationTypes.md#offchain)
- [OnChain](modules_claims.RegistrationTypes.md#onchain)

## Enumeration Members
## Enumeration members

### OffChain

• **OffChain**
• **OffChain** = `"RegistrationTypes::OffChain"`

___

### OnChain

• **OnChain**
• **OnChain** = `"RegistrationTypes::OnChain"`
10 changes: 5 additions & 5 deletions docs/api/enums/modules_domains.NamespaceType.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@

## Table of contents

### Enumeration Members
### Enumeration members

- [Application](modules_domains.NamespaceType.md#application)
- [Organization](modules_domains.NamespaceType.md#organization)
- [Role](modules_domains.NamespaceType.md#role)

## Enumeration Members
## Enumeration members

### Application

• **Application**
• **Application** = `"apps"`

___

### Organization

• **Organization**
• **Organization** = `"org"`

___

### Role

• **Role**
• **Role** = `"roles"`
6 changes: 3 additions & 3 deletions docs/api/enums/modules_messaging.MessagingMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

## Table of contents

### Enumeration Members
### Enumeration members

- [Nats](modules_messaging.MessagingMethod.md#nats)

## Enumeration Members
## Enumeration members

### Nats

• **Nats**
• **Nats** = `"nats"`
12 changes: 6 additions & 6 deletions docs/api/enums/modules_signer.ProviderEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,37 @@

## Table of contents

### Enumeration Members
### Enumeration members

- [AccountChanged](modules_signer.ProviderEvent.md#accountchanged)
- [Disconnected](modules_signer.ProviderEvent.md#disconnected)
- [NetworkChanged](modules_signer.ProviderEvent.md#networkchanged)
- [SessionUpdate](modules_signer.ProviderEvent.md#sessionupdate)

## Enumeration Members
## Enumeration members

### AccountChanged

• **AccountChanged**
• **AccountChanged** = `"accountsChanged"`

Metamask events https://docs.metamask.io/guide/ethereum-provider.html#events

___

### Disconnected

• **Disconnected**
• **Disconnected** = `"disconnect"`

WalletConnect events https://docs.walletconnect.com/1.0/client-api#register-event-subscription

___

### NetworkChanged

• **NetworkChanged**
• **NetworkChanged** = `"networkChanged"`

___

### SessionUpdate

• **SessionUpdate**
• **SessionUpdate** = `"session_update"`
Loading