feat: initiate credential exchange

energywebfoundation · Apr 22, 2022 · 099eb64 · 099eb64
1 parent 4940b39
commit 099eb64
Show file tree

Hide file tree

Showing 26 changed files with 839 additions and 218 deletions.
diff --git a/docs/Quick_start.md b/docs/Quick_start.md
@@ -71,8 +71,12 @@ setCacheConfig(1111, {
   cacheServerSupportsAuth: true,
 });
 
-const { cacheClient, domainsService, connectToDidRegistry } =
-  await connectToCacheServer();
+const {
+  cacheClient,
+  domainsService,
+  connectToDidRegistry,
+  verifiableCredentialsService,
+} = await connectToCacheServer();
 ```
 
 3. Connecting to DID registry.

diff --git a/docs/api/classes/modules_cache_client.CacheClient.md b/docs/api/classes/modules_cache_client.CacheClient.md
@@ -16,6 +16,10 @@
 
 - [pubKeyAndIdentityToken](modules_cache_client.CacheClient.md#pubkeyandidentitytoken)
 
+### Accessors
+
+- [http](modules_cache_client.CacheClient.md#http)
+
 ### Methods
 
 - [addDIDToWatchList](modules_cache_client.CacheClient.md#adddidtowatchlist)
@@ -77,6 +81,16 @@
 
 [ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[pubKeyAndIdentityToken](../interfaces/modules_cache_client.ICacheClient.md#pubkeyandidentitytoken)
 
+## Accessors
+
+### http
+
+• `get` **http**(): `AxiosInstance`
+
+#### Returns
+
+`AxiosInstance`
+
 ## Methods
 
 ### addDIDToWatchList

diff --git a/.../api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md b/.../api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md
@@ -13,20 +13,22 @@
 - [createPresentation](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createpresentation)
 - [createRoleVC](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createrolevc)
 - [createVerifiablePresentation](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createverifiablepresentation)
+- [initiateExchange](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#initiateexchange)
 - [verify](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#verify)
 - [create](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#create)
 
 ## Constructors
 
 ### constructor
 
-• **new VerifiableCredentialsServiceBase**(`_signerService`)
+• **new VerifiableCredentialsServiceBase**(`_signerService`, `_storage`)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `_signerService` | [`SignerService`](modules_signer.SignerService.md) |
+| `_storage` | `default` |
 
 ## Methods
 
@@ -81,6 +83,26 @@ ___
 
 ___
 
+### initiateExchange
+
+▸ **initiateExchange**(`__namedParameters`): `Promise`<`any`[]\>
+
+**`description`** The type of the exchange. Only vc-api exchanges currently supported.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | `ExchangeInvitation` |
+
+#### Returns
+
+`Promise`<`any`[]\>
+
+credentials query with matching verifiable presentations
+
+___
+
 ### verify
 
 ▸ **verify**<`T`\>(`vp`, `options?`): `any`
@@ -106,13 +128,14 @@ ___
 
 ### create
 
-▸ `Static` **create**(`signerService`): `Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\>
+▸ `Static` **create**(`signerService`, `storage`): `Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `signerService` | [`SignerService`](modules_signer.SignerService.md) |
+| `storage` | `default` |
 
 #### Returns
 

diff --git a/docs/api/interfaces/modules_verifiable_credentials.StoreVcResult.md b/docs/api/interfaces/modules_verifiable_credentials.StoreVcResult.md
@@ -0,0 +1,22 @@
+# Interface: StoreVcResult
+
+[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).StoreVcResult
+
+## Table of contents
+
+### Properties
+
+- [status](modules_verifiable_credentials.StoreVcResult.md#status)
+- [vcId](modules_verifiable_credentials.StoreVcResult.md#vcid)
+
+## Properties
+
+### status
+
+• **status**: ``"OK"`` \| ``"FAILED"``
+
+___
+
+### vcId
+
+• **vcId**: `string`
diff --git a/docs/api/interfaces/modules_verifiable_credentials.WebNodeQueryMessage.md b/docs/api/interfaces/modules_verifiable_credentials.WebNodeQueryMessage.md
@@ -0,0 +1,26 @@
+# Interface: WebNodeQueryMessage
+
+[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).WebNodeQueryMessage
+
+## Table of contents
+
+### Properties
+
+- [descriptor](modules_verifiable_credentials.WebNodeQueryMessage.md#descriptor)
+
+## Properties
+
+### descriptor
+
+• **descriptor**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `cid?` | `string` |
+| `dataFormat?` | `string` |
+| `dateSort?` | ``"createdAscending"`` \| ``"createdDescending"`` \| ``"publishedAscending"`` \| ``"publishedDescending"`` |
+| `method` | ``"CollectionsQuery"`` |
+| `objectId?` | `string` |
+| `schema?` | `string` |
diff --git a/docs/api/interfaces/modules_verifiable_credentials.WebNodeReply.md b/docs/api/interfaces/modules_verifiable_credentials.WebNodeReply.md
@@ -0,0 +1,35 @@
+# Interface: WebNodeReply<T\>
+
+[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).WebNodeReply
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `unknown` |
+
+## Table of contents
+
+### Properties
+
+- [entries](modules_verifiable_credentials.WebNodeReply.md#entries)
+- [messageId](modules_verifiable_credentials.WebNodeReply.md#messageid)
+- [status](modules_verifiable_credentials.WebNodeReply.md#status)
+
+## Properties
+
+### entries
+
+• `Optional` **entries**: `T`
+
+___
+
+### messageId
+
+• **messageId**: `string`
+
+___
+
+### status
+
+• `Optional` **status**: [`WebNodeStatus`](modules_verifiable_credentials.WebNodeStatus.md)
diff --git a/docs/api/interfaces/modules_verifiable_credentials.WebNodeRequestObject.md b/docs/api/interfaces/modules_verifiable_credentials.WebNodeRequestObject.md
@@ -0,0 +1,29 @@
+# Interface: WebNodeRequestObject
+
+[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).WebNodeRequestObject
+
+## Table of contents
+
+### Properties
+
+- [messages](modules_verifiable_credentials.WebNodeRequestObject.md#messages)
+- [requestId](modules_verifiable_credentials.WebNodeRequestObject.md#requestid)
+- [target](modules_verifiable_credentials.WebNodeRequestObject.md#target)
+
+## Properties
+
+### messages
+
+• **messages**: ([`WebNodeWriteMessage`](modules_verifiable_credentials.WebNodeWriteMessage.md) \| [`WebNodeQueryMessage`](modules_verifiable_credentials.WebNodeQueryMessage.md))[]
+
+___
+
+### requestId
+
+• **requestId**: `string`
+
+___
+
+### target
+
+• **target**: `string`
diff --git a/docs/api/interfaces/modules_verifiable_credentials.WebNodeResponseObject.md b/docs/api/interfaces/modules_verifiable_credentials.WebNodeResponseObject.md
@@ -0,0 +1,35 @@
+# Interface: WebNodeResponseObject<T\>
+
+[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).WebNodeResponseObject
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `unknown` |
+
+## Table of contents
+
+### Properties
+
+- [replies](modules_verifiable_credentials.WebNodeResponseObject.md#replies)
+- [requestId](modules_verifiable_credentials.WebNodeResponseObject.md#requestid)
+- [status](modules_verifiable_credentials.WebNodeResponseObject.md#status)
+
+## Properties
+
+### replies
+
+• `Optional` **replies**: [`WebNodeReply`](modules_verifiable_credentials.WebNodeReply.md)<`T`\>[]
+
+___
+
+### requestId
+
+• **requestId**: `string`
+
+___
+
+### status
+
+• `Optional` **status**: [`WebNodeStatus`](modules_verifiable_credentials.WebNodeStatus.md)
diff --git a/docs/api/interfaces/modules_verifiable_credentials.WebNodeStatus.md b/docs/api/interfaces/modules_verifiable_credentials.WebNodeStatus.md
@@ -0,0 +1,22 @@
+# Interface: WebNodeStatus
+
+[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).WebNodeStatus
+
+## Table of contents
+
+### Properties
+
+- [code](modules_verifiable_credentials.WebNodeStatus.md#code)
+- [message](modules_verifiable_credentials.WebNodeStatus.md#message)
+
+## Properties
+
+### code
+
+• **code**: `number`
+
+___
+
+### message
+
+• `Optional` **message**: `string`
diff --git a/docs/api/interfaces/modules_verifiable_credentials.WebNodeWriteMessage.md b/docs/api/interfaces/modules_verifiable_credentials.WebNodeWriteMessage.md
@@ -0,0 +1,34 @@
+# Interface: WebNodeWriteMessage
+
+[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).WebNodeWriteMessage
+
+## Table of contents
+
+### Properties
+
+- [data](modules_verifiable_credentials.WebNodeWriteMessage.md#data)
+- [descriptor](modules_verifiable_credentials.WebNodeWriteMessage.md#descriptor)
+
+## Properties
+
+### data
+
+• **data**: `string`
+
+___
+
+### descriptor
+
+• **descriptor**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `cid` | `string` |
+| `dataFormat?` | `string` |
+| `dateCreated` | `number` |
+| `datePublished?` | `number` |
+| `method` | ``"CollectionsWrite"`` |
+| `objectId` | `string` |
+| `schema?` | `string` |