diff --git a/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md b/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md index c1a85528..080257cc 100644 --- a/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md +++ b/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md @@ -22,6 +22,7 @@ verifiableCredentialsService.createRoleVC(...); - [createPresentation](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createpresentation) - [createRoleVC](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createrolevc) - [createVerifiablePresentation](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createverifiablepresentation) +- [getCredentialsByDefinition](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#getcredentialsbydefinition) - [initiateExchange](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#initiateexchange) - [verify](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#verify) - [create](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#create) @@ -30,13 +31,14 @@ verifiableCredentialsService.createRoleVC(...); ### constructor -• **new VerifiableCredentialsServiceBase**(`_signerService`) +• **new VerifiableCredentialsServiceBase**(`_signerService`, `_cacheClient`) #### Parameters | Name | Type | | :------ | :------ | | `_signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `_cacheClient` | [`CacheClient`](modules_cache_client.CacheClient.md) | ## Methods @@ -127,6 +129,26 @@ verifiable presentation ___ +### getCredentialsByDefinition + +▸ **getCredentialsByDefinition**(`presentationDefinition`): `Promise`<`SelectResults`\> + +Returns issued role verifiable credentials which matches definition + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `presentationDefinition` | `IPresentationDefinition` | credential requirements | + +#### Returns + +`Promise`<`SelectResults`\> + +results of matching each role verifiable credential to definition + +___ + ### initiateExchange ▸ **initiateExchange**(`options`): `Promise`<`ContinueExchangeSelections`\> @@ -188,13 +210,14 @@ ___ ### create -▸ `Static` **create**(`signerService`): `Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> +▸ `Static` **create**(`signerService`, `claimsService`): `Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> #### Parameters | Name | Type | | :------ | :------ | | `signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `claimsService` | [`CacheClient`](modules_cache_client.CacheClient.md) | #### Returns diff --git a/docs/api/interfaces/modules_domains.DeleteApplicationOptions.md b/docs/api/interfaces/modules_domains.DeleteApplicationOptions.md index f27b7d51..c06c53ea 100644 --- a/docs/api/interfaces/modules_domains.DeleteApplicationOptions.md +++ b/docs/api/interfaces/modules_domains.DeleteApplicationOptions.md @@ -21,6 +21,6 @@ ___ ### returnSteps -• **returnSteps**: `string` +• `Optional` **returnSteps**: `boolean` Indicates whether to run steps immediately (false) or return steps that can be executed later (true) diff --git a/docs/api/interfaces/modules_domains.DeleteOrganizationOptions.md b/docs/api/interfaces/modules_domains.DeleteOrganizationOptions.md index 21f2640a..84a05111 100644 --- a/docs/api/interfaces/modules_domains.DeleteOrganizationOptions.md +++ b/docs/api/interfaces/modules_domains.DeleteOrganizationOptions.md @@ -21,6 +21,6 @@ ___ ### returnSteps -• **returnSteps**: `string` +• `Optional` **returnSteps**: `boolean` Indicates whether to run steps immediately (false) or return steps that can be executed later (true) diff --git a/docs/api/interfaces/modules_verifiable_credentials.InitiateExchangeResults.md b/docs/api/interfaces/modules_verifiable_credentials.InitiateExchangeResults.md index 18ef21a3..83f1f898 100644 --- a/docs/api/interfaces/modules_verifiable_credentials.InitiateExchangeResults.md +++ b/docs/api/interfaces/modules_verifiable_credentials.InitiateExchangeResults.md @@ -13,7 +13,7 @@ ### presentationDefinition -• **presentationDefinition**: `PresentationDefinition` +• **presentationDefinition**: `IPresentationDefinition` ___ diff --git a/docs/api/modules/init.md b/docs/api/modules/init.md index 6173f7ea..f3371496 100644 --- a/docs/api/modules/init.md +++ b/docs/api/modules/init.md @@ -16,7 +16,7 @@ ### init -▸ **init**(`signerService`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +▸ **init**(`signerService`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> #### Parameters @@ -26,13 +26,13 @@ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> ___ ### initWithEKC -▸ **initWithEKC**(`proxyUrl?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +▸ **initWithEKC**(`proxyUrl?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> #### Parameters @@ -42,13 +42,13 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> ___ ### initWithGnosis -▸ **initWithGnosis**(`safeAppSdk`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +▸ **initWithGnosis**(`safeAppSdk`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> #### Parameters @@ -58,13 +58,13 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> ___ ### initWithKms -▸ **initWithKms**(`__namedParameters?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +▸ **initWithKms**(`__namedParameters?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> #### Parameters @@ -76,23 +76,23 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> ___ ### initWithMetamask -▸ **initWithMetamask**(): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +▸ **initWithMetamask**(): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> ___ ### initWithPrivateKeySigner -▸ **initWithPrivateKeySigner**(`privateKey`, `rpcUrl`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +▸ **initWithPrivateKeySigner**(`privateKey`, `rpcUrl`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> #### Parameters @@ -103,13 +103,13 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> ___ ### initWithWalletConnect -▸ **initWithWalletConnect**(`bridge?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +▸ **initWithWalletConnect**(`bridge?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> #### Parameters @@ -119,4 +119,4 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_did_registry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) }\> diff --git a/docs/api/modules/modules_verifiable_credentials.md b/docs/api/modules/modules_verifiable_credentials.md index 172edc91..f2cc52da 100644 --- a/docs/api/modules/modules_verifiable_credentials.md +++ b/docs/api/modules/modules_verifiable_credentials.md @@ -85,13 +85,14 @@ ___ ### getVerifiableCredentialsService -▸ **getVerifiableCredentialsService**(`signerService`): `Promise`<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> +▸ **getVerifiableCredentialsService**(`signerService`, `cacheClient`): `Promise`<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> #### Parameters | Name | Type | | :------ | :------ | | `signerService` | [`SignerService`](../classes/modules_signer.SignerService.md) | +| `cacheClient` | [`CacheClient`](../classes/modules_cache_client.CacheClient.md) | #### Returns diff --git a/src/modules/domains/domains.service.ts b/src/modules/domains/domains.service.ts index 16ce46d0..bddbac4f 100644 --- a/src/modules/domains/domains.service.ts +++ b/src/modules/domains/domains.service.ts @@ -621,7 +621,7 @@ export class DomainsService { */ async deleteOrganization({ namespace, - returnSteps, + returnSteps = false, }: DeleteOrganizationOptions): Promise< ReturnStepWithRetryCheck[] | undefined > { @@ -705,7 +705,7 @@ export class DomainsService { */ async deleteApplication({ namespace, - returnSteps, + returnSteps = false, }: DeleteApplicationOptions): Promise< ReturnStepWithRetryCheck[] | undefined > { diff --git a/src/modules/domains/domains.types.ts b/src/modules/domains/domains.types.ts index 18ed1231..82ca3dd8 100644 --- a/src/modules/domains/domains.types.ts +++ b/src/modules/domains/domains.types.ts @@ -174,7 +174,7 @@ export interface DeleteOrganizationOptions { namespace: string; /** Indicates whether to run steps immediately (false) or return steps that can be executed later (true) */ - returnSteps: string; + returnSteps?: boolean; } export interface DeleteApplicationOptions { @@ -182,7 +182,7 @@ export interface DeleteApplicationOptions { namespace: string; /** Indicates whether to run steps immediately (false) or return steps that can be executed later (true) */ - returnSteps: string; + returnSteps?: boolean; } export interface DeleteRoleOptions {