diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index aeb5fe84..8eecd2a1 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,11 @@ +### [8.1.2-alpha.1](https://github.com/energywebfoundation/iam-client-lib/compare/v8.1.1...v8.1.2-alpha.1) (2024-07-25) + + +### Bug Fixes + +* set axios-retry config ([407af9e](https://github.com/energywebfoundation/iam-client-lib/commit/407af9eb6ed11989e2b67c989997f13af5f069d0)) +* set axios-retry config ([175dd06](https://github.com/energywebfoundation/iam-client-lib/commit/175dd0652b9bafc44413b92debcee4627d744446)) + ### [8.1.1](https://github.com/energywebfoundation/iam-client-lib/compare/v8.1.0...v8.1.1) (2024-07-22) diff --git a/docs/api/classes/modules_assets.AssetsService.md b/docs/api/classes/modules_assets.AssetsService.md index 269bdd74..80ec3d32 100644 --- a/docs/api/classes/modules_assets.AssetsService.md +++ b/docs/api/classes/modules_assets.AssetsService.md @@ -37,7 +37,7 @@ assetsService.registerAsset(); ### constructor -• **new AssetsService**(`_signerService`, `_cacheClient`) +• **new AssetsService**(`_signerService`, `_cacheClient`): [`AssetsService`](modules_assets.AssetsService.md) #### Parameters @@ -46,11 +46,15 @@ assetsService.registerAsset(); | `_signerService` | [`SignerService`](modules_signer.SignerService.md) | | `_cacheClient` | [`CacheClient`](modules_cache_client.CacheClient.md) | +#### Returns + +[`AssetsService`](modules_assets.AssetsService.md) + ## Methods ### acceptAssetOffer -▸ **acceptAssetOffer**(`options`): `Promise`<`void`\> +▸ **acceptAssetOffer**(`options`): `Promise`\<`void`\> Accept an offered asset. @@ -68,13 +72,13 @@ assetsService.acceptAssetOffer({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### cancelAssetOffer -▸ **cancelAssetOffer**(`options`): `Promise`<`void`\> +▸ **cancelAssetOffer**(`options`): `Promise`\<`void`\> Cancel an asset offer. @@ -92,13 +96,13 @@ assetsService.cancelAssetOffer({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### getAssetById -▸ **getAssetById**(`options`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\> +▸ **getAssetById**(`options`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)\> Retrieve asset by id. @@ -116,7 +120,7 @@ assetsService.getAssetById({ #### Returns -`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\> +`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)\> asset @@ -124,7 +128,7 @@ ___ ### getAssetHistory -▸ **getAssetHistory**(`options`): `Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> +▸ **getAssetHistory**(`options`): `Promise`\<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> Retrieve history of a given asset DID @@ -146,7 +150,7 @@ assetsService.getAssetHistory({ #### Returns -`Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> +`Promise`\<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> asset history @@ -154,7 +158,7 @@ ___ ### getAssetOwner -▸ **getAssetOwner**(`id`): `Promise`<`string`\> +▸ **getAssetOwner**(`id`): `Promise`\<`string`\> Retrieve DID of the asset owner of the given asset DID. @@ -170,7 +174,7 @@ assetsService.getAssetOwner('did:ethr:volta:0x000...1'); #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> asset owner DID @@ -178,7 +182,7 @@ ___ ### getOfferedAssets -▸ **getOfferedAssets**(`options?`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +▸ **getOfferedAssets**(`options?`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> Retrieve assets offered to the given user. @@ -196,7 +200,7 @@ assetsService.getOfferedAssets({ #### Returns -`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> offered assets @@ -204,7 +208,7 @@ ___ ### getOwnedAssets -▸ **getOwnedAssets**(`options?`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +▸ **getOwnedAssets**(`options?`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> Retrieve owned assets of the given user. @@ -222,7 +226,7 @@ assetsService.getOwnedAssets({ #### Returns -`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> owned assets @@ -230,7 +234,7 @@ ___ ### getPreviouslyOwnedAssets -▸ **getPreviouslyOwnedAssets**(`options`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +▸ **getPreviouslyOwnedAssets**(`options`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> Retrieve previously owned assets of the given user. @@ -248,7 +252,7 @@ assetsService.getPreviouslyOwnedAssets({ #### Returns -`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> previously owned assets @@ -256,17 +260,17 @@ ___ ### init -▸ **init**(): `Promise`<`void`\> +▸ **init**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### offerAsset -▸ **offerAsset**(`options`): `Promise`<`void`\> +▸ **offerAsset**(`options`): `Promise`\<`void`\> Send an asset offer transfer to a given address @@ -285,13 +289,13 @@ assetsService.offerAsset({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### registerAsset -▸ **registerAsset**(): `Promise`<`string`\> +▸ **registerAsset**(): `Promise`\<`string`\> Register a new asset to the user. @@ -301,7 +305,7 @@ assetsService.registerAsset(); #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> asset address @@ -309,7 +313,7 @@ ___ ### rejectAssetOffer -▸ **rejectAssetOffer**(`options`): `Promise`<`void`\> +▸ **rejectAssetOffer**(`options`): `Promise`\<`void`\> Reject an offered asset. @@ -327,13 +331,13 @@ assetsService.rejectAssetOffer({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### create -▸ `Static` **create**(`signerService`, `cacheClient`): `Promise`<[`AssetsService`](modules_assets.AssetsService.md)\> +▸ **create**(`signerService`, `cacheClient`): `Promise`\<[`AssetsService`](modules_assets.AssetsService.md)\> #### Parameters @@ -344,4 +348,4 @@ ___ #### Returns -`Promise`<[`AssetsService`](modules_assets.AssetsService.md)\> +`Promise`\<[`AssetsService`](modules_assets.AssetsService.md)\> diff --git a/docs/api/classes/modules_cache_client.CacheClient.md b/docs/api/classes/modules_cache_client.CacheClient.md index c16154f5..c486084e 100644 --- a/docs/api/classes/modules_cache_client.CacheClient.md +++ b/docs/api/classes/modules_cache_client.CacheClient.md @@ -65,7 +65,7 @@ ### constructor -• **new CacheClient**(`_signerService`) +• **new CacheClient**(`_signerService`): [`CacheClient`](modules_cache_client.CacheClient.md) #### Parameters @@ -73,6 +73,10 @@ | :------ | :------ | | `_signerService` | [`SignerService`](modules_signer.SignerService.md) | +#### Returns + +[`CacheClient`](modules_cache_client.CacheClient.md) + ## Accessors ### http @@ -87,7 +91,7 @@ ### addDIDToWatchList -▸ **addDIDToWatchList**(`did`): `Promise`<`void`\> +▸ **addDIDToWatchList**(`did`): `Promise`\<`void`\> #### Parameters @@ -97,7 +101,7 @@ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> #### Implementation of @@ -107,7 +111,7 @@ ___ ### addStatusToCredential -▸ **addStatusToCredential**(`credential`): `Promise`<`Credential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> & { `credentialStatus`: `StatusList2021Entry` }\> +▸ **addStatusToCredential**(`credential`): `Promise`\<`Credential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> & \{ `credentialStatus`: `StatusList2021Entry` }\> Sets location of the credential status @@ -115,11 +119,11 @@ Sets location of the credential status | Name | Type | Description | | :------ | :------ | :------ | -| `credential` | `Credential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | unsigned credential | +| `credential` | `Credential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | unsigned credential | #### Returns -`Promise`<`Credential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> & { `credentialStatus`: `StatusList2021Entry` }\> +`Promise`\<`Credential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> & \{ `credentialStatus`: `StatusList2021Entry` }\> credential with reference to status location @@ -127,17 +131,17 @@ ___ ### authenticate -▸ **authenticate**(): `Promise`<`void`\> +▸ **authenticate**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### deleteClaim -▸ **deleteClaim**(`id`): `Promise`<`void`\> +▸ **deleteClaim**(`id`): `Promise`\<`void`\> #### Parameters @@ -147,7 +151,7 @@ ___ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> #### Implementation of @@ -157,7 +161,7 @@ ___ ### getAllowedRolesByIssuer -▸ **getAllowedRolesByIssuer**(`did`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +▸ **getAllowedRolesByIssuer**(`did`): `Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Parameters @@ -167,13 +171,13 @@ ___ #### Returns -`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> ___ ### getAppDefinition -▸ **getAppDefinition**(`namespace`): `Promise`<`IAppDefinition`\> +▸ **getAppDefinition**(`namespace`): `Promise`\<`IAppDefinition`\> #### Parameters @@ -183,7 +187,7 @@ ___ #### Returns -`Promise`<`IAppDefinition`\> +`Promise`\<`IAppDefinition`\> #### Implementation of @@ -193,7 +197,7 @@ ___ ### getApplicationRoles -▸ **getApplicationRoles**(`namespace`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +▸ **getApplicationRoles**(`namespace`): `Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Parameters @@ -203,7 +207,7 @@ ___ #### Returns -`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Implementation of @@ -213,7 +217,7 @@ ___ ### getApplicationsByOrganization -▸ **getApplicationsByOrganization**(`namespace`): `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> +▸ **getApplicationsByOrganization**(`namespace`): `Promise`\<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> #### Parameters @@ -223,7 +227,7 @@ ___ #### Returns -`Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> +`Promise`\<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> #### Implementation of @@ -233,7 +237,7 @@ ___ ### getApplicationsByOwner -▸ **getApplicationsByOwner**(`owner`, `withRelations?`): `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> +▸ **getApplicationsByOwner**(`owner`, `withRelations?`): `Promise`\<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> #### Parameters @@ -244,7 +248,7 @@ ___ #### Returns -`Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> +`Promise`\<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> #### Implementation of @@ -254,7 +258,7 @@ ___ ### getAssetById -▸ **getAssetById**(`id`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\> +▸ **getAssetById**(`id`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)\> #### Parameters @@ -264,7 +268,7 @@ ___ #### Returns -`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\> +`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)\> #### Implementation of @@ -274,7 +278,7 @@ ___ ### getAssetHistory -▸ **getAssetHistory**(`id`, `«destructured»?`): `Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> +▸ **getAssetHistory**(`id`, `«destructured»?`): `Promise`\<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> #### Parameters @@ -285,7 +289,7 @@ ___ #### Returns -`Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> +`Promise`\<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> #### Implementation of @@ -295,7 +299,7 @@ ___ ### getClaimById -▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> +▸ **getClaimById**(`claimId`): `Promise`\<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> #### Parameters @@ -305,7 +309,7 @@ ___ #### Returns -`Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> +`Promise`\<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> #### Implementation of @@ -315,7 +319,7 @@ ___ ### getClaimsByIssuer -▸ **getClaimsByIssuer**(`issuer`, `«destructured»?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsByIssuer**(`issuer`, `«destructured»?`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Parameters @@ -326,7 +330,7 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Implementation of @@ -336,7 +340,7 @@ ___ ### getClaimsByRequester -▸ **getClaimsByRequester**(`requester`, `«destructured»?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsByRequester**(`requester`, `«destructured»?`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Parameters @@ -347,7 +351,7 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Implementation of @@ -357,7 +361,7 @@ ___ ### getClaimsByRevoker -▸ **getClaimsByRevoker**(`revoker`, `«destructured»?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsByRevoker**(`revoker`, `«destructured»?`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Parameters @@ -368,7 +372,7 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Implementation of @@ -378,7 +382,7 @@ ___ ### getClaimsBySubject -▸ **getClaimsBySubject**(`subject`, `«destructured»?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsBySubject**(`subject`, `«destructured»?`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Parameters @@ -389,7 +393,7 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Implementation of @@ -399,7 +403,7 @@ ___ ### getClaimsBySubjects -▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsBySubjects**(`subjects`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Parameters @@ -409,7 +413,7 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Implementation of @@ -419,7 +423,7 @@ ___ ### getDIDsForRole -▸ **getDIDsForRole**(`namespace`): `Promise`<`string`[]\> +▸ **getDIDsForRole**(`namespace`): `Promise`\<`string`[]\> #### Parameters @@ -429,7 +433,7 @@ ___ #### Returns -`Promise`<`string`[]\> +`Promise`\<`string`[]\> #### Implementation of @@ -439,7 +443,7 @@ ___ ### getDidDocument -▸ **getDidDocument**(`did`, `includeClaims?`): `Promise`<`IDIDDocument`\> +▸ **getDidDocument**(`did`, `includeClaims?`): `Promise`\<`IDIDDocument`\> #### Parameters @@ -450,7 +454,7 @@ ___ #### Returns -`Promise`<`IDIDDocument`\> +`Promise`\<`IDIDDocument`\> #### Implementation of @@ -460,7 +464,7 @@ ___ ### getNamespaceBySearchPhrase -▸ **getNamespaceBySearchPhrase**(`search`, `types?`): `Promise`<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> +▸ **getNamespaceBySearchPhrase**(`search`, `types?`): `Promise`\<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> #### Parameters @@ -471,7 +475,7 @@ ___ #### Returns -`Promise`<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> +`Promise`\<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> #### Implementation of @@ -481,7 +485,7 @@ ___ ### getOfferedAssets -▸ **getOfferedAssets**(`did`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +▸ **getOfferedAssets**(`did`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> #### Parameters @@ -491,7 +495,7 @@ ___ #### Returns -`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> #### Implementation of @@ -501,7 +505,7 @@ ___ ### getOrgDefinition -▸ **getOrgDefinition**(`namespace`): `Promise`<`IOrganizationDefinition`\> +▸ **getOrgDefinition**(`namespace`): `Promise`\<`IOrganizationDefinition`\> #### Parameters @@ -511,7 +515,7 @@ ___ #### Returns -`Promise`<`IOrganizationDefinition`\> +`Promise`\<`IOrganizationDefinition`\> #### Implementation of @@ -521,7 +525,7 @@ ___ ### getOrgHierarchy -▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> +▸ **getOrgHierarchy**(`namespace`): `Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> #### Parameters @@ -531,7 +535,7 @@ ___ #### Returns -`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> +`Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> #### Implementation of @@ -541,7 +545,7 @@ ___ ### getOrganizationRoles -▸ **getOrganizationRoles**(`namespace`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +▸ **getOrganizationRoles**(`namespace`): `Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Parameters @@ -551,7 +555,7 @@ ___ #### Returns -`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Implementation of @@ -561,7 +565,7 @@ ___ ### getOrganizationsByOwner -▸ **getOrganizationsByOwner**(`owner`, `withRelations?`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> +▸ **getOrganizationsByOwner**(`owner`, `withRelations?`): `Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> #### Parameters @@ -572,7 +576,7 @@ ___ #### Returns -`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> +`Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> #### Implementation of @@ -582,7 +586,7 @@ ___ ### getOwnedAssets -▸ **getOwnedAssets**(`did`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +▸ **getOwnedAssets**(`did`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> #### Parameters @@ -592,7 +596,7 @@ ___ #### Returns -`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> #### Implementation of @@ -602,7 +606,7 @@ ___ ### getPreviouslyOwnedAssets -▸ **getPreviouslyOwnedAssets**(`owner`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +▸ **getPreviouslyOwnedAssets**(`owner`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> #### Parameters @@ -612,7 +616,7 @@ ___ #### Returns -`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> #### Implementation of @@ -622,7 +626,7 @@ ___ ### getRoleDefinition -▸ **getRoleDefinition**(`namespace`): `Promise`<`IRoleDefinition` \| `IRoleDefinitionV2`\> +▸ **getRoleDefinition**(`namespace`): `Promise`\<`IRoleDefinition` \| `IRoleDefinitionV2`\> #### Parameters @@ -632,7 +636,7 @@ ___ #### Returns -`Promise`<`IRoleDefinition` \| `IRoleDefinitionV2`\> +`Promise`\<`IRoleDefinition` \| `IRoleDefinitionV2`\> #### Implementation of @@ -642,7 +646,7 @@ ___ ### getRolesByOwner -▸ **getRolesByOwner**(`owner`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +▸ **getRolesByOwner**(`owner`): `Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Parameters @@ -652,7 +656,7 @@ ___ #### Returns -`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Implementation of @@ -662,7 +666,7 @@ ___ ### getRolesByRevoker -▸ **getRolesByRevoker**(`revoker`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +▸ **getRolesByRevoker**(`revoker`): `Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Parameters @@ -672,7 +676,7 @@ ___ #### Returns -`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> #### Implementation of @@ -682,7 +686,7 @@ ___ ### getRolesDefinition -▸ **getRolesDefinition**(`namespaces`): `Promise`<`Record`<`string`, `IRoleDefinition`\>\> +▸ **getRolesDefinition**(`namespaces`): `Promise`\<`Record`\<`string`, `IRoleDefinition`\>\> #### Parameters @@ -692,7 +696,7 @@ ___ #### Returns -`Promise`<`Record`<`string`, `IRoleDefinition`\>\> +`Promise`\<`Record`\<`string`, `IRoleDefinition`\>\> #### Implementation of @@ -702,7 +706,7 @@ ___ ### getStatusListCredential -▸ **getStatusListCredential**(`credential`): `Promise`<``null`` \| [`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> +▸ **getStatusListCredential**(`credential`): `Promise`\<``null`` \| [`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> Fetch the StatusList2021Credential object from storage. @@ -710,11 +714,11 @@ Fetch the StatusList2021Credential object from storage. | Name | Type | Description | | :------ | :------ | :------ | -| `credential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential with status list 2021 | +| `credential` | `VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential with status list 2021 | #### Returns -`Promise`<``null`` \| [`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> +`Promise`\<``null`` \| [`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> status list credential if found @@ -722,7 +726,7 @@ ___ ### getSubOrganizationsByOrganization -▸ **getSubOrganizationsByOrganization**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> +▸ **getSubOrganizationsByOrganization**(`namespace`): `Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> #### Parameters @@ -732,7 +736,7 @@ ___ #### Returns -`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> +`Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> #### Implementation of @@ -742,17 +746,17 @@ ___ ### init -▸ **init**(): `Promise`<`void`\> +▸ **init**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### initiateCredentialStatusUpdate -▸ **initiateCredentialStatusUpdate**(`verifiableCredential`): `Promise`<[`StatusList2021UnsignedCredential`](../interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md)\> +▸ **initiateCredentialStatusUpdate**(`verifiableCredential`): `Promise`\<[`StatusList2021UnsignedCredential`](../interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md)\> Get the StatusList2021Credential object to be signed @@ -760,11 +764,11 @@ Get the StatusList2021Credential object to be signed | Name | Type | Description | | :------ | :------ | :------ | -| `verifiableCredential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential to be revoked | +| `verifiableCredential` | `VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential to be revoked | #### Returns -`Promise`<[`StatusList2021UnsignedCredential`](../interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md)\> +`Promise`\<[`StatusList2021UnsignedCredential`](../interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md)\> unsigned status list credential @@ -782,17 +786,17 @@ ___ ### isAuthenticated -▸ **isAuthenticated**(): `Promise`<`boolean`\> +▸ **isAuthenticated**(): `Promise`\<`boolean`\> #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> ___ ### issueClaim -▸ **issueClaim**(`issuer`, `message`): `Promise`<`void`\> +▸ **issueClaim**(`issuer`, `message`): `Promise`\<`void`\> #### Parameters @@ -803,7 +807,7 @@ ___ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> #### Implementation of @@ -813,17 +817,17 @@ ___ ### login -▸ **login**(): `Promise`<`void`\> +▸ **login**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### persistCredentialStatusUpdate -▸ **persistCredentialStatusUpdate**(`statusListCredential`): `Promise`<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> +▸ **persistCredentialStatusUpdate**(`statusListCredential`): `Promise`\<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> Persist signed StatusList2021Credential object in storage. @@ -835,7 +839,7 @@ Persist signed StatusList2021Credential object in storage. #### Returns -`Promise`<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> +`Promise`\<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> status list credential @@ -843,7 +847,7 @@ ___ ### rejectClaim -▸ **rejectClaim**(`issuer`, `message`): `Promise`<`void`\> +▸ **rejectClaim**(`issuer`, `message`): `Promise`\<`void`\> #### Parameters @@ -854,7 +858,7 @@ ___ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> #### Implementation of @@ -864,7 +868,7 @@ ___ ### requestClaim -▸ **requestClaim**(`message`): `Promise`<`void`\> +▸ **requestClaim**(`message`): `Promise`\<`void`\> #### Parameters @@ -874,7 +878,7 @@ ___ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> #### Implementation of diff --git a/docs/api/classes/modules_claims.CachedIssuerResolver.md b/docs/api/classes/modules_claims.CachedIssuerResolver.md index f6961d24..c7dfc768 100644 --- a/docs/api/classes/modules_claims.CachedIssuerResolver.md +++ b/docs/api/classes/modules_claims.CachedIssuerResolver.md @@ -20,7 +20,7 @@ ### constructor -• **new CachedIssuerResolver**(`domainsService`) +• **new CachedIssuerResolver**(`domainsService`): [`CachedIssuerResolver`](modules_claims.CachedIssuerResolver.md) #### Parameters @@ -28,11 +28,15 @@ | :------ | :------ | | `domainsService` | [`DomainsService`](modules_domains.DomainsService.md) | +#### Returns + +[`CachedIssuerResolver`](modules_claims.CachedIssuerResolver.md) + ## Methods ### getIssuerDefinition -▸ **getIssuerDefinition**(`namespace`): `Promise`<`IIssuerDefinition`\> +▸ **getIssuerDefinition**(`namespace`): `Promise`\<`IIssuerDefinition`\> #### Parameters @@ -42,7 +46,7 @@ #### Returns -`Promise`<`IIssuerDefinition`\> +`Promise`\<`IIssuerDefinition`\> #### Implementation of diff --git a/docs/api/classes/modules_claims.ClaimsService.md b/docs/api/classes/modules_claims.ClaimsService.md index 03c970e3..e923f2da 100644 --- a/docs/api/classes/modules_claims.ClaimsService.md +++ b/docs/api/classes/modules_claims.ClaimsService.md @@ -56,7 +56,7 @@ claimsService.getClaimById(claim.id); ### constructor -• **new ClaimsService**(`_signerService`, `_domainsService`, `_cacheClient`, `_didRegistry`, `_verifiableCredentialService`) +• **new ClaimsService**(`_signerService`, `_domainsService`, `_cacheClient`, `_didRegistry`, `_verifiableCredentialService`): [`ClaimsService`](modules_claims.ClaimsService.md) #### Parameters @@ -68,11 +68,15 @@ claimsService.getClaimById(claim.id); | `_didRegistry` | [`DidRegistry`](modules_did_registry.DidRegistry.md) | | `_verifiableCredentialService` | [`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) | +#### Returns + +[`ClaimsService`](modules_claims.ClaimsService.md) + ## Methods ### claimRevocationDetails -▸ **claimRevocationDetails**(`options`): `Promise`<`undefined` \| [`ClaimRevocationDetailsResult`](../interfaces/modules_claims.ClaimRevocationDetailsResult.md)\> +▸ **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. @@ -99,7 +103,7 @@ claimsService.claimRevocationDetails({ #### Returns -`Promise`<`undefined` \| [`ClaimRevocationDetailsResult`](../interfaces/modules_claims.ClaimRevocationDetailsResult.md)\> +`Promise`\<`undefined` \| [`ClaimRevocationDetailsResult`](../interfaces/modules_claims.ClaimRevocationDetailsResult.md)\> revocation details @@ -107,7 +111,7 @@ ___ ### createClaimRequest -▸ **createClaimRequest**(`options`): `Promise`<`void`\> +▸ **createClaimRequest**(`options`): `Promise`\<`void`\> Allows subject to request for credential by creating and sending a claim request to claim issuer. @@ -131,13 +135,13 @@ claimsService.createClaimRequest({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### createDelegateProof -▸ **createDelegateProof**(`delegateKey`, `identity`, `algorithm?`): `Promise`<`string`\> +▸ **createDelegateProof**(`delegateKey`, `identity`, `algorithm?`): `Promise`\<`string`\> Create a public claim to prove identity. @@ -159,7 +163,7 @@ claimsService.createDelegateProof( #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> JWT token of delegate @@ -167,7 +171,7 @@ ___ ### createIdentityProof -▸ **createIdentityProof**(): `Promise`<`string`\> +▸ **createIdentityProof**(): `Promise`\<`string`\> Create a public claim to prove identity. @@ -177,7 +181,7 @@ claimsService.createIdentityProof(); #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> JWT token of created identity @@ -185,7 +189,7 @@ ___ ### createSelfSignedClaim -▸ **createSelfSignedClaim**(`options`): `Promise`<`string`\> +▸ **createSelfSignedClaim**(`options`): `Promise`\<`string`\> Creates self signed off-chain claim with `data` and adds it to `subject` document. Signer must own or control subject. @@ -213,7 +217,7 @@ claimsService.createSelfSignedClaim({ #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> URl to IPFS @@ -221,7 +225,7 @@ ___ ### deleteClaim -▸ **deleteClaim**(`options`): `Promise`<`void`\> +▸ **deleteClaim**(`options`): `Promise`\<`void`\> Delete claim request. Works only for pending claims (not issued or rejected). @@ -239,13 +243,13 @@ claimsService.deleteClaim({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### fetchCredential -▸ **fetchCredential**(`subjectDID`, `roleNamespace`): `Promise`<`undefined` \| `VerifiableCredential`<`RoleCredentialSubject`\> \| `RoleEIP191JWT`\> +▸ **fetchCredential**(`subjectDID`, `roleNamespace`): `Promise`\<`undefined` \| `VerifiableCredential`\<`RoleCredentialSubject`\> \| `RoleEIP191JWT`\> Fetch a credential from storage @@ -258,7 +262,7 @@ Fetch a credential from storage #### Returns -`Promise`<`undefined` \| `VerifiableCredential`<`RoleCredentialSubject`\> \| `RoleEIP191JWT`\> +`Promise`\<`undefined` \| `VerifiableCredential`\<`RoleCredentialSubject`\> \| `RoleEIP191JWT`\> credential if available or undefined if not @@ -266,7 +270,7 @@ ___ ### getClaimById -▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> +▸ **getClaimById**(`claimId`): `Promise`\<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> Retrieve claim with given id. @@ -283,7 +287,7 @@ claimsService.getClaimById(claimId); #### Returns -`Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> +`Promise`\<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> claim with given id @@ -291,7 +295,7 @@ ___ ### getClaimId -▸ **getClaimId**(`«destructured»`): `Promise`<`string`\> +▸ **getClaimId**(`«destructured»`): `Promise`\<`string`\> Generates claim id or returns id of existing claim with same data @@ -304,7 +308,7 @@ Generates claim id or returns id of existing claim with same data #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> claim identifier @@ -312,7 +316,7 @@ ___ ### getClaimsByIssuer -▸ **getClaimsByIssuer**(`options`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsByIssuer**(`options`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> Retrieve claims issued by a given issuer with allowing filter by status and parent namespace. @@ -332,7 +336,7 @@ claimsService.getClaimsByIssuer({ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> list of claims @@ -340,7 +344,7 @@ ___ ### getClaimsByRequester -▸ **getClaimsByRequester**(`options`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsByRequester**(`options`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> Retrieve claims requested by a given requester with allowing filter by status and parent namespace. @@ -360,7 +364,7 @@ claimsService.getClaimsByRequester({ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> list of claims @@ -368,7 +372,7 @@ ___ ### getClaimsByRevoker -▸ **getClaimsByRevoker**(`options`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsByRevoker**(`options`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> Retrieve all claims that a user can revoke. Allow to filter by namespace @@ -387,7 +391,7 @@ claimsService.getClaimsByRevoker({ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> list of claims @@ -395,7 +399,7 @@ ___ ### getClaimsBySubject -▸ **getClaimsBySubject**(`options`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsBySubject**(`options`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> Retrieve claims for given subject with allowing filter by status and parent namespace. @@ -415,7 +419,7 @@ claimsService.getClaimsBySubject({ #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> list of claims @@ -423,7 +427,7 @@ ___ ### getClaimsBySubjects -▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +▸ **getClaimsBySubjects**(`subjects`): `Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> Retrieve claims related to a given subjects. @@ -439,7 +443,7 @@ claimsService.getClaimsBySubjects(['did:ethr:0x00...0', 'did:ethr:0x00...1', ... #### Returns -`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> list of claims @@ -473,7 +477,7 @@ ___ ### getUserClaims -▸ **getUserClaims**(`options`): `Promise`<`IServiceEndpoint` & `Pick`<`ClaimData`, ``"claimType"`` \| ``"claimTypeVersion"``\>[]\> +▸ **getUserClaims**(`options`): `Promise`\<`IServiceEndpoint` & `Pick`\<`ClaimData`, ``"claimType"`` \| ``"claimTypeVersion"``\>[]\> Get published off-chain claims of the given subject. @@ -491,7 +495,7 @@ claimsService.getUserClaims({ #### Returns -`Promise`<`IServiceEndpoint` & `Pick`<`ClaimData`, ``"claimType"`` \| ``"claimTypeVersion"``\>[]\> +`Promise`\<`IServiceEndpoint` & `Pick`\<`ClaimData`, ``"claimType"`` \| ``"claimTypeVersion"``\>[]\> Claims containing DID document service endpoints @@ -499,7 +503,7 @@ ___ ### hasOnChainRole -▸ **hasOnChainRole**(`did`, `role`, `version`): `Promise`<`boolean`\> +▸ **hasOnChainRole**(`did`, `role`, `version`): `Promise`\<`boolean`\> A utility function to check the blockchain directly if a DID has a role. @@ -517,7 +521,7 @@ claimsService.hasOnChainRole('did:ethr:ewc:0x00...0', 'email.roles.iam.ewc', 1); #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> `true` if DID has role at the version. `false` if not. @@ -525,17 +529,17 @@ ___ ### init -▸ **init**(): `Promise`<`void`\> +▸ **init**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### isClaimRevoked -▸ **isClaimRevoked**(`options`): `Promise`<`boolean`\> +▸ **isClaimRevoked**(`options`): `Promise`\<`boolean`\> Check if On-Chain claim is revoked. @@ -562,7 +566,7 @@ claimsService.isClaimRevoked({ #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if claim is revoked @@ -570,7 +574,7 @@ ___ ### issueClaim -▸ **issueClaim**(`options`): `Promise`<`undefined` \| `string`\> +▸ **issueClaim**(`options`): `Promise`\<`undefined` \| `string`\> Issue claim without previous request. Option available for issuers only. If `credentialStatus` is not overridden then status from ssi-hub will be set. @@ -595,7 +599,7 @@ claimsService.issueClaim({ #### Returns -`Promise`<`undefined` \| `string`\> +`Promise`\<`undefined` \| `string`\> Issued token if registrationTypes includes RegistrationTypes.OffChain @@ -603,7 +607,7 @@ ___ ### issueClaimRequest -▸ **issueClaimRequest**(`options`): `Promise`<`void`\> +▸ **issueClaimRequest**(`options`): `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. @@ -630,13 +634,13 @@ claimsService.issueClaimRequest({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### publishPublicClaim -▸ **publishPublicClaim**(`options`): `Promise`<`undefined` \| `string`\> +▸ **publishPublicClaim**(`options`): `Promise`\<`undefined` \| `string`\> Register role to claim manager contract if registrationTypes includes RegistrationTypes.OnChain Publish role to IPFS and add DID document service if registrationTypes includes RegistrationTypes.OffChain @@ -660,7 +664,7 @@ claimsService.publishPublicClaim({ #### Returns -`Promise`<`undefined` \| `string`\> +`Promise`\<`undefined` \| `string`\> URl to IPFS if registrationTypes includes RegistrationTypes.OffChain @@ -668,7 +672,7 @@ ___ ### registerOnchain -▸ **registerOnchain**(`claim`): `Promise`<`void`\> +▸ **registerOnchain**(`claim`): `Promise`\<`void`\> Register issued on-chain claim on Claim Manager contract Can be used by asset owners to register credentials on-chain for their assets. @@ -692,13 +696,13 @@ claimsService.registerOnchain({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### rejectClaimRequest -▸ **rejectClaimRequest**(`options`): `Promise`<`void`\> +▸ **rejectClaimRequest**(`options`): `Promise`\<`void`\> Reject claim request. @@ -719,13 +723,13 @@ claimsService.rejectClaimRequest({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### resolveCredentialAndVerify -▸ **resolveCredentialAndVerify**(`subjectDID`, `roleNamespace`): `Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> +▸ **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 @@ -738,7 +742,7 @@ Resolve a credential from storage and verify its proof/signature and its issuer' #### Returns -`Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> +`Promise`\<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> void. Returns "Proof Not Verified" error if VC not verified. Returns error if issuer not verified @@ -746,7 +750,7 @@ ___ ### revokeClaim -▸ **revokeClaim**(`options`): `Promise`<`boolean`\> +▸ **revokeClaim**(`options`): `Promise`\<`boolean`\> Revoke On-Chain issued claim by `claimId` or given `namespace` and `subject`. Required `claimId` or `claim` parameters. @@ -775,7 +779,7 @@ claimsService.revokeClaim({ #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if claim was revoked @@ -783,7 +787,7 @@ ___ ### revokeMultipleClaim -▸ **revokeMultipleClaim**(`options`): `Promise`<`void`\> +▸ **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. @@ -817,7 +821,7 @@ claimsService.revokeMultipleClaim({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ @@ -839,7 +843,7 @@ ___ ### verifyRoleEIP191JWT -▸ **verifyRoleEIP191JWT**(`roleEIP191JWT`): `Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> +▸ **verifyRoleEIP191JWT**(`roleEIP191JWT`): `Promise`\<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> Verifies: - That off-chain claim was issued by authorized issuer @@ -853,7 +857,7 @@ Verifies: #### Returns -`Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> +`Promise`\<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> Boolean indicating if verified and array of error messages @@ -861,7 +865,7 @@ ___ ### verifyVc -▸ **verifyVc**(`vc`): `Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> +▸ **verifyVc**(`vc`): `Promise`\<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> Verifies: - That credential proof is valid @@ -872,11 +876,11 @@ Verifies: | Name | Type | Description | | :------ | :------ | :------ | -| `vc` | `VerifiableCredential`<`RoleCredentialSubject`\> | to be verified | +| `vc` | `VerifiableCredential`\<`RoleCredentialSubject`\> | to be verified | #### Returns -`Promise`<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> +`Promise`\<[`CredentialVerificationResult`](../interfaces/modules_claims.CredentialVerificationResult.md)\> Boolean indicating if verified and array of error messages @@ -884,7 +888,7 @@ ___ ### create -▸ `Static` **create**(`signerService`, `domainsService`, `cacheClient`, `didRegistry`, `verifiableCredentialService`): `Promise`<[`ClaimsService`](modules_claims.ClaimsService.md)\> +▸ **create**(`signerService`, `domainsService`, `cacheClient`, `didRegistry`, `verifiableCredentialService`): `Promise`\<[`ClaimsService`](modules_claims.ClaimsService.md)\> #### Parameters @@ -898,4 +902,4 @@ ___ #### Returns -`Promise`<[`ClaimsService`](modules_claims.ClaimsService.md)\> +`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 index b22030c9..65117036 100644 --- a/docs/api/classes/modules_did_registry.DidRegistry.md +++ b/docs/api/classes/modules_did_registry.DidRegistry.md @@ -48,7 +48,7 @@ didRegistry.getDidDocument(); ### constructor -• **new DidRegistry**(`_signerService`, `_cacheClient`, `_assetsService`, `_ipfsConfig`) +• **new DidRegistry**(`_signerService`, `_cacheClient`, `_assetsService`, `_ipfsConfig`): [`DidRegistry`](modules_did_registry.DidRegistry.md) #### Parameters @@ -59,6 +59,10 @@ didRegistry.getDidDocument(); | `_assetsService` | [`AssetsService`](modules_assets.AssetsService.md) | | `_ipfsConfig` | [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md) | +#### Returns + +[`DidRegistry`](modules_did_registry.DidRegistry.md) + ## Accessors ### identityOwner @@ -103,7 +107,7 @@ ___ ### createDocument -▸ **createDocument**(): `Promise`<`boolean`\> +▸ **createDocument**(): `Promise`\<`boolean`\> Create DID document of the current user if not exists. @@ -113,7 +117,7 @@ didRegistry.createDocument(); #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if document was created successfully @@ -121,7 +125,7 @@ ___ ### createPublicClaim -▸ **createPublicClaim**(`options`): `Promise`<`string`\> +▸ **createPublicClaim**(`options`): `Promise`\<`string`\> Create a public claim with provided data. @@ -143,7 +147,7 @@ didRegistry.createPublicClaim({ #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> JWT token of created claim @@ -151,7 +155,7 @@ ___ ### decodeJWTToken -▸ **decodeJWTToken**(`options`): `Promise`<`unknown`\> +▸ **decodeJWTToken**(`options`): `Promise`\<`unknown`\> Decode JWT token of the public claim. @@ -169,7 +173,7 @@ didRegistry.decodeJWTToken({ #### Returns -`Promise`<`unknown`\> +`Promise`\<`unknown`\> payload of the JWT token @@ -177,7 +181,7 @@ ___ ### getDidDelegates -▸ **getDidDelegates**(`options?`): `Promise`<`undefined` \| `string`[]\> +▸ **getDidDelegates**(`options?`): `Promise`\<`undefined` \| `string`[]\> Gets delegates from DID document of the given DID. @@ -195,7 +199,7 @@ didRegistry.getDidDelegates({ #### Returns -`Promise`<`undefined` \| `string`[]\> +`Promise`\<`undefined` \| `string`[]\> list of delegates @@ -203,7 +207,7 @@ ___ ### getDidDocument -▸ **getDidDocument**(`options?`): `Promise`<`IDIDDocument`\> +▸ **getDidDocument**(`options?`): `Promise`\<`IDIDDocument`\> Retrieve DID Document of the given DID from SSI-Hub if possible, otherwise from blockchain. Optionally include claims object within services in the document. @@ -223,7 +227,7 @@ didRegistry.getDidDocument({ #### Returns -`Promise`<`IDIDDocument`\> +`Promise`\<`IDIDDocument`\> DID document @@ -231,7 +235,7 @@ ___ ### getDidPublicKeys -▸ **getDidPublicKeys**(`options?`): `Promise`<`IPublicKey`[]\> +▸ **getDidPublicKeys**(`options?`): `Promise`\<`IPublicKey`[]\> Gets public keys from DID document of the given DID. @@ -249,7 +253,7 @@ didRegistry.getDidPublicKeys({ #### Returns -`Promise`<`IPublicKey`[]\> +`Promise`\<`IPublicKey`[]\> list of public keys @@ -257,7 +261,7 @@ ___ ### getServices -▸ **getServices**(`options?`): `Promise`<`IServiceEndpoint`[]\> +▸ **getServices**(`options?`): `Promise`\<`IServiceEndpoint`[]\> Gets services from DID document of the given DID. @@ -275,7 +279,7 @@ didRegistry.getServices({ #### Returns -`Promise`<`IServiceEndpoint`[]\> +`Promise`\<`IServiceEndpoint`[]\> list of claims @@ -283,11 +287,11 @@ ___ ### init -▸ **init**(): `Promise`<`void`\> +▸ **init**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ @@ -317,7 +321,7 @@ ___ ### issuePublicClaim -▸ **issuePublicClaim**(`options`): `Promise`<`string`\> +▸ **issuePublicClaim**(`options`): `Promise`\<`string`\> If token provided issue new token signed by issuer, otherwise create a new claim token based on provided public claim data. @@ -343,7 +347,7 @@ didRegistry.issuePublicClaim({ #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> JWT token of created claim @@ -351,7 +355,7 @@ ___ ### revokeDidDocument -▸ **revokeDidDocument**(): `Promise`<`boolean`\> +▸ **revokeDidDocument**(): `Promise`\<`boolean`\> Revoke DID document of the current user. @@ -361,7 +365,7 @@ didRegistry.revokeDidDocument(); #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if document was revoked successfully @@ -369,7 +373,7 @@ ___ ### updateDocument -▸ **updateDocument**(`«destructured»`): `Promise`<`boolean`\> +▸ **updateDocument**(`«destructured»`): `Promise`\<`boolean`\> Update DID document of the given DID with provided data. @@ -392,13 +396,13 @@ didRegistry.updateDocument({ #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> ___ ### updateSignedDidDelegate -▸ **updateSignedDidDelegate**(`«destructured»`): `Promise`<`boolean`\> +▸ **updateSignedDidDelegate**(`«destructured»`): `Promise`\<`boolean`\> Updates delegate of the DID document of given DID. @@ -422,13 +426,13 @@ didRegistry.updateSignedDidDelegate({ #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> ___ ### updateSignedDidPublicKey -▸ **updateSignedDidPublicKey**(`«destructured»`): `Promise`<`boolean`\> +▸ **updateSignedDidPublicKey**(`«destructured»`): `Promise`\<`boolean`\> Adds public key to the DID document of given DID. @@ -453,13 +457,13 @@ didRegistry.updateSignedDidPublicKey({ #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> ___ ### verifyPublicClaim -▸ **verifyPublicClaim**(`token`, `iss`): `Promise`<``null`` \| `string`\> +▸ **verifyPublicClaim**(`token`, `iss`): `Promise`\<``null`` \| `string`\> Verifies issued token of the public claim. @@ -479,7 +483,7 @@ didRegistry.verifyPublicClaim({ #### Returns -`Promise`<``null`` \| `string`\> +`Promise`\<``null`` \| `string`\> DID of the authenticated identity on successful verification or null otherwise @@ -487,7 +491,7 @@ ___ ### connect -▸ `Static` **connect**(`signerService`, `cacheClient`, `assetsService`, `ipfsConfig`): `Promise`<[`DidRegistry`](modules_did_registry.DidRegistry.md)\> +▸ **connect**(`signerService`, `cacheClient`, `assetsService`, `ipfsConfig`): `Promise`\<[`DidRegistry`](modules_did_registry.DidRegistry.md)\> #### Parameters @@ -500,4 +504,4 @@ ___ #### Returns -`Promise`<[`DidRegistry`](modules_did_registry.DidRegistry.md)\> +`Promise`\<[`DidRegistry`](modules_did_registry.DidRegistry.md)\> diff --git a/docs/api/classes/modules_domains.DomainsService.md b/docs/api/classes/modules_domains.DomainsService.md index 966df71c..9a32ab4d 100644 --- a/docs/api/classes/modules_domains.DomainsService.md +++ b/docs/api/classes/modules_domains.DomainsService.md @@ -58,7 +58,7 @@ domainsService.createOrganization(...); ### constructor -• **new DomainsService**(`_signerService`, `_cacheClient`) +• **new DomainsService**(`_signerService`, `_cacheClient`): [`DomainsService`](modules_domains.DomainsService.md) #### Parameters @@ -67,6 +67,10 @@ domainsService.createOrganization(...); | `_signerService` | [`SignerService`](modules_signer.SignerService.md) | | `_cacheClient` | [`CacheClient`](modules_cache_client.CacheClient.md) | +#### Returns + +[`DomainsService`](modules_domains.DomainsService.md) + ## Accessors ### domainReader @@ -81,7 +85,7 @@ domainsService.createOrganization(...); ### changeAppOwnership -▸ **changeAppOwnership**(`options`): `Promise`<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> +▸ **changeAppOwnership**(`options`): `Promise`\<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> Change owner of application domain. @@ -101,7 +105,7 @@ domainsService.changeAppOwnership({ #### Returns -`Promise`<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> +`Promise`\<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> array of steps if `returnSteps` is true @@ -109,7 +113,7 @@ ___ ### changeOrgOwnership -▸ **changeOrgOwnership**(`options`): `Promise`<`undefined` \| [`MulticallTx`](../modules/modules_domains.md#multicalltx)\> +▸ **changeOrgOwnership**(`options`): `Promise`\<`undefined` \| [`MulticallTx`](../modules/modules_domains.md#multicalltx)\> Change owner of organization domain including all subdomains. @@ -130,7 +134,7 @@ domainsService.changeOrgOwnership({ #### Returns -`Promise`<`undefined` \| [`MulticallTx`](../modules/modules_domains.md#multicalltx)\> +`Promise`\<`undefined` \| [`MulticallTx`](../modules/modules_domains.md#multicalltx)\> array of steps if `returnSteps` is true @@ -138,7 +142,7 @@ ___ ### changeRoleOwnership -▸ **changeRoleOwnership**(`options`): `Promise`<`void`\> +▸ **changeRoleOwnership**(`options`): `Promise`\<`void`\> Change owner of role domain. @@ -157,13 +161,13 @@ domainsService.changeRoleOwnership({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### checkExistenceOfDomain -▸ **checkExistenceOfDomain**(`options`): `Promise`<`boolean`\> +▸ **checkExistenceOfDomain**(`options`): `Promise`\<`boolean`\> Check if domain exists in ENS registry. @@ -181,7 +185,7 @@ domainsService.checkExistenceOfDomain({ #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if domain exists, false otherwise @@ -189,7 +193,7 @@ ___ ### createApplication -▸ **createApplication**(`options`): `Promise`<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> +▸ **createApplication**(`options`): `Promise`\<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> Create application domain with given definition for given namespace. Also includes creating subdomain for roles. (roles.yourApp.apps.yourOrg.ewc). @@ -213,7 +217,7 @@ domainsService.createApplication({ #### Returns -`Promise`<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> +`Promise`\<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> array of steps if `returnSteps` is true @@ -221,7 +225,7 @@ ___ ### createOrganization -▸ **createOrganization**(`options`): `Promise`<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> +▸ **createOrganization**(`options`): `Promise`\<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> Create organization domain with given definition for given namespace. Also includes creating subdomains for roles and applications. (roles.yourOrg.ewc, apps.yourOrg.ewc). @@ -245,7 +249,7 @@ domainsService.createOrganization({ #### Returns -`Promise`<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> +`Promise`\<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> array of steps if `returnSteps` is true @@ -253,7 +257,7 @@ ___ ### createRole -▸ **createRole**(`options`): `Promise`<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> +▸ **createRole**(`options`): `Promise`\<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> Create role domain with given definition for given namespace. @@ -285,7 +289,7 @@ domainsService.createRole({ #### Returns -`Promise`<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> +`Promise`\<`undefined` \| [`ReturnStep`](../interfaces/modules_domains.ReturnStep.md)[]\> array of steps if `returnSteps` is true @@ -293,7 +297,7 @@ ___ ### deleteApplication -▸ **deleteApplication**(`options`): `Promise`<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> +▸ **deleteApplication**(`options`): `Promise`\<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> Delete application domain and all subdomains. @@ -312,7 +316,7 @@ domainsService.deleteApplication({ #### Returns -`Promise`<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> +`Promise`\<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> array of steps if `returnSteps` is true @@ -320,7 +324,7 @@ ___ ### deleteOrganization -▸ **deleteOrganization**(`options`): `Promise`<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> +▸ **deleteOrganization**(`options`): `Promise`\<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> Delete organization domain and all subdomains. @@ -339,7 +343,7 @@ domainsService.deleteOrganization({ #### Returns -`Promise`<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> +`Promise`\<`undefined` \| [`ReturnStepWithRetryCheck`](../interfaces/modules_domains.ReturnStepWithRetryCheck.md)[]\> array of steps if `returnSteps` is true @@ -347,7 +351,7 @@ ___ ### deleteRole -▸ **deleteRole**(`options`): `Promise`<`void`\> +▸ **deleteRole**(`options`): `Promise`\<`void`\> Delete role domain. @@ -365,13 +369,13 @@ domainsService.deleteRole({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### getAllowedRolesByIssuer -▸ **getAllowedRolesByIssuer**(`did`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +▸ **getAllowedRolesByIssuer**(`did`): `Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> Get all roles that a DID can issue. @@ -387,7 +391,7 @@ domainsService.getAllowedRolesByIssuer('did:ethr:0x00...0'); #### Returns -`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> array of roles that the DID can issue @@ -395,7 +399,7 @@ ___ ### getAllowedRolesByRevoker -▸ **getAllowedRolesByRevoker**(`did`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +▸ **getAllowedRolesByRevoker**(`did`): `Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> Get all roles that a DID can revoke. @@ -411,7 +415,7 @@ domainsService.getAllowedRolesByRevoker('did:ethr:0x00...0'); #### Returns -`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> array of roles that the DID can issue @@ -419,7 +423,7 @@ ___ ### getAppsOfOrg -▸ **getAppsOfOrg**(`org`): `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> +▸ **getAppsOfOrg**(`org`): `Promise`\<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> Fetch all applications for organization namespace. @@ -435,7 +439,7 @@ domainsService.getAppsOfOrg('energyweb.iam.ewc'); #### Returns -`Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> +`Promise`\<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> array of applications @@ -443,7 +447,7 @@ ___ ### getDIDsByRole -▸ **getDIDsByRole**(`role`): `Promise`<`string`[]\> +▸ **getDIDsByRole**(`role`): `Promise`\<`string`[]\> Get users did which have certain role. @@ -459,7 +463,7 @@ domainsService.getDIDsByRole('auth.roles.energyweb.iam.ewc'); #### Returns -`Promise`<`string`[]\> +`Promise`\<`string`[]\> array of users DID @@ -467,7 +471,7 @@ ___ ### getDefinition -▸ **getDefinition**(`options`): `Promise`<`IRoleDefinition` \| `IRoleDefinitionV2` \| `IOrganizationDefinition` \| `IAppDefinition`\> +▸ **getDefinition**(`options`): `Promise`\<`IRoleDefinition` \| `IRoleDefinitionV2` \| `IOrganizationDefinition` \| `IAppDefinition`\> Fetch cached domain definition for organization, application or role. @@ -486,7 +490,7 @@ domainsService.getDefinition({ #### Returns -`Promise`<`IRoleDefinition` \| `IRoleDefinitionV2` \| `IOrganizationDefinition` \| `IAppDefinition`\> +`Promise`\<`IRoleDefinition` \| `IRoleDefinitionV2` \| `IOrganizationDefinition` \| `IAppDefinition`\> domain definition @@ -494,7 +498,7 @@ ___ ### 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`\<[`IApp`](../interfaces/modules_domains.IApp.md)[] \| [`IRole`](../interfaces/modules_domains.IRole.md)[] \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> Get all organization/application/role for certain owner. @@ -514,7 +518,7 @@ domainsService.getENSTypesByOwner({ #### Returns -`Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[] \| [`IRole`](../interfaces/modules_domains.IRole.md)[] \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> +`Promise`\<[`IApp`](../interfaces/modules_domains.IApp.md)[] \| [`IRole`](../interfaces/modules_domains.IRole.md)[] \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> array of organizations/applications/roles for certain owner @@ -522,7 +526,7 @@ ___ ### getENSTypesBySearchPhrase -▸ **getENSTypesBySearchPhrase**(`search`, `types?`): `Promise`<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> +▸ **getENSTypesBySearchPhrase**(`search`, `types?`): `Promise`\<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> Search for organization/application/role with a given search phrase. @@ -542,7 +546,7 @@ domainsService.getENSTypesBySearchPhrase({ #### Returns -`Promise`<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> +`Promise`\<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> array of founded organizations/applications/roles @@ -550,7 +554,7 @@ ___ ### getOrgHierarchy -▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> +▸ **getOrgHierarchy**(`namespace`): `Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> Get organization hierarchy. Max 20 levels deep. @@ -566,7 +570,7 @@ domainsService.getOrgHierarchy('energyweb.iam.ewc'); #### Returns -`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> +`Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> organization with all nested sub-organizations @@ -574,7 +578,7 @@ ___ ### getRolesByNamespace -▸ **getRolesByNamespace**(`options`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +▸ **getRolesByNamespace**(`options`): `Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> Fetch all roles subdomains for certain domain. @@ -593,7 +597,7 @@ domainsService.getRolesByNamespace({ #### Returns -`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> array of role subdomains @@ -601,7 +605,7 @@ ___ ### getSubOrgsByOrgNamespace -▸ **getSubOrgsByOrgNamespace**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> +▸ **getSubOrgsByOrgNamespace**(`namespace`): `Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> Fetch all sub-organizations for organization namespace. @@ -617,7 +621,7 @@ domainsService.getSubOrgsByOrgNamespace('energyweb.iam.ewc'); #### Returns -`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> +`Promise`\<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> array of sub-organizations @@ -625,7 +629,7 @@ ___ ### getSubdomains -▸ **getSubdomains**(`options`): `Promise`<`string`[]\> +▸ **getSubdomains**(`options`): `Promise`\<`string`[]\> Fetch subdomains for certain domain. @@ -644,7 +648,7 @@ domainsService.getSubdomains({ #### Returns -`Promise`<`string`[]\> +`Promise`\<`string`[]\> array of subdomains @@ -652,17 +656,17 @@ ___ ### init -▸ **init**(): `Promise`<`void`\> +▸ **init**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### isOwner -▸ **isOwner**(`options`): `Promise`<`boolean`\> +▸ **isOwner**(`options`): `Promise`\<`boolean`\> Check if user is owner of the domain. @@ -681,7 +685,7 @@ domainsService.isOwner({ #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if user is owner, false otherwise @@ -689,7 +693,7 @@ ___ ### namespacesWithRelations -▸ **namespacesWithRelations**(`namespaces`): `Promise`<{ `namespace`: `string` ; `owner`: `string` }[]\> +▸ **namespacesWithRelations**(`namespaces`): `Promise`\<\{ `namespace`: `string` ; `owner`: `string` }[]\> Collect related data for given domain. Currently only related data is owner. @@ -707,13 +711,13 @@ domainsService.namespacesWithRelations(['root.roles.energyweb.iam.ewc', 'admin.r #### Returns -`Promise`<{ `namespace`: `string` ; `owner`: `string` }[]\> +`Promise`\<\{ `namespace`: `string` ; `owner`: `string` }[]\> ___ ### readName -▸ **readName**(`namehashToRead`): `Promise`<`string`\> +▸ **readName**(`namehashToRead`): `Promise`\<`string`\> #### Parameters @@ -723,13 +727,13 @@ ___ #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> ___ ### registrationTypesOfRoles -▸ **registrationTypesOfRoles**(`roles`): `Promise`<`Record`<`string`, `Set`<[`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)\>\>\> +▸ **registrationTypesOfRoles**(`roles`): `Promise`\<`Record`\<`string`, `Set`\<[`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)\>\>\> Get possible registration types for given roles. @@ -747,13 +751,13 @@ domainsService.registrationTypesOfRoles(['root.roles.energyweb.iam.ewc', 'admin. #### Returns -`Promise`<`Record`<`string`, `Set`<[`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)\>\>\> +`Promise`\<`Record`\<`string`, `Set`\<[`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)\>\>\> ___ ### setRoleDefinition -▸ **setRoleDefinition**(`options`): `Promise`<`void`\> +▸ **setRoleDefinition**(`options`): `Promise`\<`void`\> Update ENS domain definition for already created domain. @@ -774,13 +778,13 @@ domainsService.setRoleDefinition({ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### updateLegacyDefinition -▸ **updateLegacyDefinition**(`domain`, `data`): `Promise`<`boolean`\> +▸ **updateLegacyDefinition**(`domain`, `data`): `Promise`\<`boolean`\> Move domain to latest version of resolver. @@ -809,13 +813,13 @@ domainsService.updateLegacyDefinition({ #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> ___ ### validateOwnership -▸ **validateOwnership**(`options`): `Promise`<`string`[]\> +▸ **validateOwnership**(`options`): `Promise`\<`string`[]\> Get not owned domains in given namespace for current user. @@ -834,7 +838,7 @@ domainsService.validateOwnership({ #### Returns -`Promise`<`string`[]\> +`Promise`\<`string`[]\> array of not owned domains @@ -842,7 +846,7 @@ ___ ### create -▸ `Static` **create**(`signerService`, `cacheClient`): `Promise`<[`DomainsService`](modules_domains.DomainsService.md)\> +▸ **create**(`signerService`, `cacheClient`): `Promise`\<[`DomainsService`](modules_domains.DomainsService.md)\> #### Parameters @@ -853,4 +857,4 @@ ___ #### Returns -`Promise`<[`DomainsService`](modules_domains.DomainsService.md)\> +`Promise`\<[`DomainsService`](modules_domains.DomainsService.md)\> diff --git a/docs/api/classes/modules_messaging.MessagingService.md b/docs/api/classes/modules_messaging.MessagingService.md index f034e9c0..74f0cdae 100644 --- a/docs/api/classes/modules_messaging.MessagingService.md +++ b/docs/api/classes/modules_messaging.MessagingService.md @@ -27,7 +27,7 @@ messagingService.subscribeTo(...); ### constructor -• **new MessagingService**(`_signerService`) +• **new MessagingService**(`_signerService`): [`MessagingService`](modules_messaging.MessagingService.md) #### Parameters @@ -35,15 +35,19 @@ messagingService.subscribeTo(...); | :------ | :------ | | `_signerService` | [`SignerService`](modules_signer.SignerService.md) | +#### Returns + +[`MessagingService`](modules_messaging.MessagingService.md) + ## Methods ### init -▸ **init**(): `Promise`<`void`\> +▸ **init**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ @@ -72,7 +76,7 @@ ___ ### subscribeTo -▸ **subscribeTo**(`options`): `Promise`<`undefined` \| `number`\> +▸ **subscribeTo**(`options`): `Promise`\<`undefined` \| `number`\> Subscribe to messages on the given subject. @@ -91,7 +95,7 @@ messagingService.subscribeTo({ #### Returns -`Promise`<`undefined` \| `number`\> +`Promise`\<`undefined` \| `number`\> subscription id @@ -99,7 +103,7 @@ ___ ### unsubscribeFrom -▸ **unsubscribeFrom**(`subscriptionId`): `Promise`<`void`\> +▸ **unsubscribeFrom**(`subscriptionId`): `Promise`\<`void`\> Unsubscribe from the given subscription id. @@ -115,13 +119,13 @@ messagingService.unsubscribeFrom(55); #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### create -▸ `Static` **create**(`signerService`): `Promise`<[`MessagingService`](modules_messaging.MessagingService.md)\> +▸ **create**(`signerService`): `Promise`\<[`MessagingService`](modules_messaging.MessagingService.md)\> #### Parameters @@ -131,4 +135,4 @@ ___ #### Returns -`Promise`<[`MessagingService`](modules_messaging.MessagingService.md)\> +`Promise`\<[`MessagingService`](modules_messaging.MessagingService.md)\> diff --git a/docs/api/classes/modules_signer.EkcSigner.md b/docs/api/classes/modules_signer.EkcSigner.md index 7902d4ca..e2ab3025 100644 --- a/docs/api/classes/modules_signer.EkcSigner.md +++ b/docs/api/classes/modules_signer.EkcSigner.md @@ -36,7 +36,7 @@ ### constructor -• **new EkcSigner**(`ekc`) +• **new EkcSigner**(`ekc`): [`EkcSigner`](modules_signer.EkcSigner.md) #### Parameters @@ -44,6 +44,10 @@ | :------ | :------ | | `ekc` | `default` | +#### Returns + +[`EkcSigner`](modules_signer.EkcSigner.md) + #### Overrides Signer.constructor @@ -68,11 +72,11 @@ Signer.provider ### \_signTypedData -▸ **_signTypedData**(): `Promise`<`string`\> +▸ **_signTypedData**(): `Promise`\<`string`\> #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> #### Implementation of @@ -102,11 +106,11 @@ ___ ### getAddress -▸ **getAddress**(): `Promise`<`string`\> +▸ **getAddress**(): `Promise`\<`string`\> #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> #### Overrides @@ -116,7 +120,7 @@ ___ ### signMessage -▸ **signMessage**(`message`): `Promise`<`string`\> +▸ **signMessage**(`message`): `Promise`\<`string`\> #### Parameters @@ -126,7 +130,7 @@ ___ #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> #### Overrides @@ -136,17 +140,17 @@ ___ ### signTransaction -▸ **signTransaction**(`transaction`): `Promise`<`string`\> +▸ **signTransaction**(`transaction`): `Promise`\<`string`\> #### Parameters | Name | Type | | :------ | :------ | -| `transaction` | `Deferrable`<`TransactionRequest`\> | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> #### Overrides @@ -156,7 +160,7 @@ ___ ### create -▸ `Static` **create**(`proxyUrl`): `Promise`<[`EkcSigner`](modules_signer.EkcSigner.md)\> +▸ **create**(`proxyUrl`): `Promise`\<[`EkcSigner`](modules_signer.EkcSigner.md)\> #### Parameters @@ -166,4 +170,4 @@ ___ #### Returns -`Promise`<[`EkcSigner`](modules_signer.EkcSigner.md)\> +`Promise`\<[`EkcSigner`](modules_signer.EkcSigner.md)\> diff --git a/docs/api/classes/modules_signer.SignerService.md b/docs/api/classes/modules_signer.SignerService.md index f5897ed5..a36ffb55 100644 --- a/docs/api/classes/modules_signer.SignerService.md +++ b/docs/api/classes/modules_signer.SignerService.md @@ -49,15 +49,19 @@ signerService.signMessage(...); ### constructor -• **new SignerService**(`_signer`, `_providerType`) +• **new SignerService**(`_signer`, `_providerType`): [`SignerService`](modules_signer.SignerService.md) #### Parameters | Name | Type | | :------ | :------ | -| `_signer` | `Required`<[`SignerT`](../modules/modules_signer.md#signert)\> | +| `_signer` | `Required`\<[`SignerT`](../modules/modules_signer.md#signert)\> | | `_providerType` | [`ProviderType`](../enums/modules_signer.ProviderType.md) | +#### Returns + +[`SignerService`](modules_signer.SignerService.md) + ## Accessors ### accountInfo @@ -206,7 +210,7 @@ ___ ### signer -• `get` **signer**(): `Required`<[`SignerT`](../modules/modules_signer.md#signert)\> +• `get` **signer**(): `Required`\<[`SignerT`](../modules/modules_signer.md#signert)\> The instance of the `ether` library signer in use by the service @@ -216,7 +220,7 @@ signerService.signer; #### Returns -`Required`<[`SignerT`](../modules/modules_signer.md#signert)\> +`Required`\<[`SignerT`](../modules/modules_signer.md#signert)\> signer @@ -224,7 +228,7 @@ signer ### balance -▸ **balance**(): `Promise`<`BigNumber`\> +▸ **balance**(): `Promise`\<`BigNumber`\> Get current user balance. @@ -234,7 +238,7 @@ signerService.getBalance(); #### Returns -`Promise`<`BigNumber`\> +`Promise`\<`BigNumber`\> user balance @@ -242,7 +246,7 @@ ___ ### call -▸ **call**(`options`): `Promise`<`string`\> +▸ **call**(`options`): `Promise`\<`string`\> Makes a (readonly) call to a smart contract. https://docs.ethers.io/v5/single-page/#/v5/api/providers/provider/-%23-Provider-call @@ -262,7 +266,7 @@ signerService.call({ #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> the result of the call @@ -288,7 +292,7 @@ ___ ### closeConnection -▸ **closeConnection**(): `Promise`<`boolean`\> +▸ **closeConnection**(): `Promise`\<`boolean`\> Close connection with the signer wallet. @@ -298,7 +302,7 @@ signerService.closeConnection(); #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if connection was closed @@ -306,24 +310,24 @@ ___ ### connect -▸ **connect**(`signer`, `providerType`): `Promise`<`void`\> +▸ **connect**(`signer`, `providerType`): `Promise`\<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `signer` | `Required`<[`SignerT`](../modules/modules_signer.md#signert)\> | +| `signer` | `Required`\<[`SignerT`](../modules/modules_signer.md#signert)\> | | `providerType` | [`ProviderType`](../enums/modules_signer.ProviderType.md) | #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### emit -▸ **emit**(`e`): `Promise`<`void`\> +▸ **emit**(`e`): `Promise`\<`void`\> #### Parameters @@ -333,17 +337,17 @@ ___ #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### init -▸ **init**(): `Promise`<`void`\> +▸ **init**(): `Promise`\<`void`\> #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ @@ -353,14 +357,14 @@ ___ Add event handler for certain events -**`Requires`** - -to be called after the connection to wallet was initialized - #### Returns `void` +**`Requires`** + +to be called after the connection to wallet was initialized + ___ ### on @@ -400,7 +404,7 @@ ___ ### publicKey -▸ **publicKey**(): `Promise`<`string`\> +▸ **publicKey**(): `Promise`\<`string`\> Get current user public key. @@ -410,7 +414,7 @@ signerService.publicKey(); #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> public key @@ -418,7 +422,7 @@ ___ ### publicKeyAndIdentityToken -▸ **publicKeyAndIdentityToken**(`force?`): `Promise`<[`IPubKeyAndIdentityToken`](../interfaces/modules_signer.IPubKeyAndIdentityToken.md)\> +▸ **publicKeyAndIdentityToken**(`force?`): `Promise`\<[`IPubKeyAndIdentityToken`](../interfaces/modules_signer.IPubKeyAndIdentityToken.md)\> Generate public key and identity token for authentication purposes. @@ -434,7 +438,7 @@ signerService.publicKeyAndIdentityToken(); #### Returns -`Promise`<[`IPubKeyAndIdentityToken`](../interfaces/modules_signer.IPubKeyAndIdentityToken.md)\> +`Promise`\<[`IPubKeyAndIdentityToken`](../interfaces/modules_signer.IPubKeyAndIdentityToken.md)\> object with public key and identity token @@ -442,7 +446,7 @@ ___ ### send -▸ **send**(`options`): `Promise`<`TransactionReceipt`\> +▸ **send**(`options`): `Promise`\<`TransactionReceipt`\> Send transaction to the blockchain. @@ -461,7 +465,7 @@ signerService.send({ #### Returns -`Promise`<`TransactionReceipt`\> +`Promise`\<`TransactionReceipt`\> transaction receipt @@ -469,7 +473,7 @@ ___ ### signMessage -▸ **signMessage**(`message`): `Promise`<`string`\> +▸ **signMessage**(`message`): `Promise`\<`string`\> Tries to create `eth_sign` conformant signature (https://eth.wiki/json-rpc/API#eth_sign). Whether or not to hash the message prior to signature is depends on whether is signer EIP-191 compliant. @@ -487,7 +491,7 @@ signerService.signMessage(arrayify('Hello World')); #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> the signature @@ -495,7 +499,7 @@ ___ ### signTypedData -▸ **signTypedData**(`domain`, `types`, `message`): `Promise`<`string`\> +▸ **signTypedData**(`domain`, `types`, `message`): `Promise`\<`string`\> Tries to create conformant EIP-712 signature (https://eips.ethereum.org/EIPS/eip-712). @@ -512,11 +516,11 @@ signerService.signTypedData( | Name | Type | Description | | :------ | :------ | :------ | | `domain` | `TypedDataDomain` | EIP-712 domain object | -| `types` | `Record`<`string`, `TypedDataField`[]\> | EIP-712 types object | -| `message` | `Record`<`string`, `unknown`\> | EIP-712 message object | +| `types` | `Record`\<`string`, `TypedDataField`[]\> | EIP-712 types object | +| `message` | `Record`\<`string`, `unknown`\> | EIP-712 message object | #### Returns -`Promise`<`string`\> +`Promise`\<`string`\> the signature diff --git a/docs/api/classes/modules_staking.StakingFactoryService.md b/docs/api/classes/modules_staking.StakingFactoryService.md index c99d9dc1..12468d73 100644 --- a/docs/api/classes/modules_staking.StakingFactoryService.md +++ b/docs/api/classes/modules_staking.StakingFactoryService.md @@ -20,7 +20,7 @@ Intended for staking pool ### constructor -• **new StakingFactoryService**(`_signerService`, `_domainsService`) +• **new StakingFactoryService**(`_signerService`, `_domainsService`): [`StakingFactoryService`](modules_staking.StakingFactoryService.md) #### Parameters @@ -29,39 +29,43 @@ Intended for staking pool | `_signerService` | [`SignerService`](modules_signer.SignerService.md) | | `_domainsService` | [`DomainsService`](modules_domains.DomainsService.md) | +#### Returns + +[`StakingFactoryService`](modules_staking.StakingFactoryService.md) + ## Methods ### allServices -▸ **allServices**(): `Promise`<[`Service`](../modules/modules_staking.md#service)[]\> +▸ **allServices**(): `Promise`\<[`Service`](../modules/modules_staking.md#service)[]\> -**`Description`** +#### Returns -Returns all services for which pools are launched +`Promise`\<[`Service`](../modules/modules_staking.md#service)[]\> -#### Returns +**`Description`** -`Promise`<[`Service`](../modules/modules_staking.md#service)[]\> +Returns all services for which pools are launched ___ ### getPool -▸ **getPool**(): `Promise`<[`StakingPoolService`](modules_staking.StakingPoolService.md)\> +▸ **getPool**(): `Promise`\<[`StakingPoolService`](modules_staking.StakingPoolService.md)\> -**`Description`** +#### Returns -Returns pool launched for energyweb org +`Promise`\<[`StakingPoolService`](modules_staking.StakingPoolService.md)\> -#### Returns +**`Description`** -`Promise`<[`StakingPoolService`](modules_staking.StakingPoolService.md)\> +Returns pool launched for energyweb org ___ ### create -▸ `Static` **create**(`signerService`, `domainsService`): `Promise`<[`StakingFactoryService`](modules_staking.StakingFactoryService.md)\> +▸ **create**(`signerService`, `domainsService`): `Promise`\<[`StakingFactoryService`](modules_staking.StakingFactoryService.md)\> #### Parameters @@ -72,4 +76,4 @@ ___ #### Returns -`Promise`<[`StakingFactoryService`](modules_staking.StakingFactoryService.md)\> +`Promise`\<[`StakingFactoryService`](modules_staking.StakingFactoryService.md)\> diff --git a/docs/api/classes/modules_staking.StakingPoolService.md b/docs/api/classes/modules_staking.StakingPoolService.md index 008ba397..7680e012 100644 --- a/docs/api/classes/modules_staking.StakingPoolService.md +++ b/docs/api/classes/modules_staking.StakingPoolService.md @@ -28,7 +28,7 @@ Abstraction over staking pool smart contract ### constructor -• **new StakingPoolService**(`signerService`, `address`) +• **new StakingPoolService**(`signerService`, `address`): [`StakingPoolService`](modules_staking.StakingPoolService.md) #### Parameters @@ -37,67 +37,71 @@ Abstraction over staking pool smart contract | `signerService` | [`SignerService`](modules_signer.SignerService.md) | | `address` | `string` | +#### Returns + +[`StakingPoolService`](modules_staking.StakingPoolService.md) + ## Methods ### checkReward -▸ **checkReward**(): `Promise`<`BigNumber`\> +▸ **checkReward**(): `Promise`\<`BigNumber`\> Accumulated reward #### Returns -`Promise`<`BigNumber`\> +`Promise`\<`BigNumber`\> ___ ### getContributionLimit -▸ **getContributionLimit**(): `Promise`<`BigNumber`\> +▸ **getContributionLimit**(): `Promise`\<`BigNumber`\> #### Returns -`Promise`<`BigNumber`\> +`Promise`\<`BigNumber`\> ___ ### getEnd -▸ **getEnd**(): `Promise`<`BigNumber`\> +▸ **getEnd**(): `Promise`\<`BigNumber`\> #### Returns -`Promise`<`BigNumber`\> +`Promise`\<`BigNumber`\> ___ ### getHardCap -▸ **getHardCap**(): `Promise`<`BigNumber`\> +▸ **getHardCap**(): `Promise`\<`BigNumber`\> #### Returns -`Promise`<`BigNumber`\> +`Promise`\<`BigNumber`\> ___ ### getRatio -▸ **getRatio**(): `Promise`<`BigNumber`\> +▸ **getRatio**(): `Promise`\<`BigNumber`\> #### Returns -`Promise`<`BigNumber`\> +`Promise`\<`BigNumber`\> ___ ### getStake -▸ **getStake**(): `Promise`<[`Stake`](../modules/modules_staking.md#stake)\> +▸ **getStake**(): `Promise`\<[`Stake`](../modules/modules_staking.md#stake)\> #### Returns -`Promise`<[`Stake`](../modules/modules_staking.md#stake)\> +`Promise`\<[`Stake`](../modules/modules_staking.md#stake)\> Stake @@ -105,29 +109,27 @@ ___ ### getStart -▸ **getStart**(): `Promise`<`BigNumber`\> +▸ **getStart**(): `Promise`\<`BigNumber`\> #### Returns -`Promise`<`BigNumber`\> +`Promise`\<`BigNumber`\> ___ ### getTotalStaked -▸ **getTotalStaked**(): `Promise`<`BigNumber`\> +▸ **getTotalStaked**(): `Promise`\<`BigNumber`\> #### Returns -`Promise`<`BigNumber`\> +`Promise`\<`BigNumber`\> ___ ### partialWithdraw -▸ **partialWithdraw**(`value`): `Promise`<`ContractReceipt`\> - -**`Description`** +▸ **partialWithdraw**(`value`): `Promise`\<`ContractReceipt`\> #### Parameters @@ -137,21 +139,15 @@ ___ #### Returns -`Promise`<`ContractReceipt`\> - -___ - -### putStake - -▸ **putStake**(`stake`): `Promise`<`void`\> +`Promise`\<`ContractReceipt`\> **`Description`** -Locks stake and starts accumulating reward +___ -**`Emits`** +### putStake -StakingPool.StakePut +▸ **putStake**(`stake`): `Promise`\<`void`\> #### Parameters @@ -161,18 +157,26 @@ StakingPool.StakePut #### Returns -`Promise`<`void`\> +`Promise`\<`void`\> + +**`Description`** + +Locks stake and starts accumulating reward + +**`Emits`** + +StakingPool.StakePut ___ ### withdraw -▸ **withdraw**(): `Promise`<`void`\> +▸ **withdraw**(): `Promise`\<`void`\> -**`Description`** +#### Returns -pays back stake with accumulated reward. +`Promise`\<`void`\> -#### Returns +**`Description`** -`Promise`<`void`\> +pays back stake with accumulated reward. diff --git a/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md b/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md index debd6e02..d3aa31ea 100644 --- a/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md +++ b/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md @@ -35,7 +35,7 @@ verifiableCredentialsService.createRoleVC(...); ### constructor -• **new VerifiableCredentialsServiceBase**(`_signerService`, `_cacheClient`) +• **new VerifiableCredentialsServiceBase**(`_signerService`, `_cacheClient`): [`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) #### Parameters @@ -44,33 +44,37 @@ verifiableCredentialsService.createRoleVC(...); | `_signerService` | [`SignerService`](modules_signer.SignerService.md) | | `_cacheClient` | [`CacheClient`](modules_cache_client.CacheClient.md) | +#### Returns + +[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) + ## Methods ### continueExchange -▸ **continueExchange**(`«destructured»`): `Promise`<`undefined` \| `VerifiablePresentation` \| `VpRequest`\> - -**`Description`** - -Sends credentials requested by issuer and returns either issued credentials or next credentials request +▸ **continueExchange**(`«destructured»`): `Promise`\<`undefined` \| `VerifiablePresentation` \| `VpRequest`\> #### Parameters | Name | Type | | :------ | :------ | -| `«destructured»` | `ContinueExchangeCredentials`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | +| `«destructured»` | `ContinueExchangeCredentials`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | #### Returns -`Promise`<`undefined` \| `VerifiablePresentation` \| `VpRequest`\> +`Promise`\<`undefined` \| `VerifiablePresentation` \| `VpRequest`\> issued credentials or request of additional credentials +**`Description`** + +Sends credentials requested by issuer and returns either issued credentials or next credentials request + ___ ### createCredential -▸ **createCredential**(`params`): `Credential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> +▸ **createCredential**(`params`): `Credential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> Create a credential with given parameters. @@ -92,7 +96,7 @@ await verifiableCredentialsService.createCredential({ #### Returns -`Credential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> +`Credential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> Energy Web credential @@ -112,7 +116,7 @@ verifiableCredentialsService.createPresentation([...credentials]); | Name | Type | Description | | :------ | :------ | :------ | -| `verifiableCredential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>[] | role credential parameters | +| `verifiableCredential` | `VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>[] | role credential parameters | | `options?` | [`CreatePresentationParams`](../interfaces/modules_verifiable_credentials.CreatePresentationParams.md) | presentation options | #### Returns @@ -125,7 +129,7 @@ ___ ### createRoleVC -▸ **createRoleVC**(`credentialParams`, `proofOptions?`): `Promise`<`VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>\> +▸ **createRoleVC**(`credentialParams`, `proofOptions?`): `Promise`\<`VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>\> #### Parameters @@ -136,13 +140,13 @@ ___ #### Returns -`Promise`<`VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>\> +`Promise`\<`VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>\> ___ ### createVerifiablePresentation -▸ **createVerifiablePresentation**(`verifiableCredential`, `options?`): `Promise`<`VerifiablePresentation`\> +▸ **createVerifiablePresentation**(`verifiableCredential`, `options?`): `Promise`\<`VerifiablePresentation`\> Create a verifiable presentation with given verifiable credentials and EIP712 signature. @@ -154,12 +158,12 @@ verifiableCredentialsService.createVerifiablePresentation([...credentials]); | Name | Type | Description | | :------ | :------ | :------ | -| `verifiableCredential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>[] | role credential parameters | +| `verifiableCredential` | `VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>[] | role credential parameters | | `options?` | [`ProofOptions`](../interfaces/modules_verifiable_credentials.ProofOptions.md) | proof options | #### Returns -`Promise`<`VerifiablePresentation`\> +`Promise`\<`VerifiablePresentation`\> verifiable presentation @@ -167,7 +171,7 @@ ___ ### getCredentialsByDefinition -▸ **getCredentialsByDefinition**(`presentationDefinition`): `Promise`<`SelectResults`\> +▸ **getCredentialsByDefinition**(`presentationDefinition`): `Promise`\<`SelectResults`\> Returns issued role verifiable credentials which matches definition. @@ -183,7 +187,7 @@ await verifiableCredentialsService.getCredentialsByDefinition(presentationDefini #### Returns -`Promise`<`SelectResults`\> +`Promise`\<`SelectResults`\> results of matching each role verifiable credential to definition @@ -191,7 +195,7 @@ ___ ### initiateExchange -▸ **initiateExchange**(`options`): `Promise`<`ContinueExchangeSelections`\> +▸ **initiateExchange**(`options`): `Promise`\<`ContinueExchangeSelections`\> Initialize credential exchange. Only vc-api exchanges currently supported. @@ -210,7 +214,7 @@ verifiableCredentialsService.initiateExchange({ #### Returns -`Promise`<`ContinueExchangeSelections`\> +`Promise`\<`ContinueExchangeSelections`\> credentials query with matching verifiable presentations @@ -218,7 +222,7 @@ ___ ### isRevoked -▸ **isRevoked**(`credential`): `Promise`<`boolean`\> +▸ **isRevoked**(`credential`): `Promise`\<`boolean`\> Check if given verifiable credential is revoked. @@ -230,11 +234,11 @@ await verifiableCredentialsService.isRevoked(credential); | Name | Type | Description | | :------ | :------ | :------ | -| `credential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential | +| `credential` | `VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential | #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if credential is revoked @@ -242,7 +246,7 @@ ___ ### revocationDetails -▸ **revocationDetails**(`credential`): `Promise`<``null`` \| [`CredentialRevocationDetailsResult`](../interfaces/modules_verifiable_credentials.CredentialRevocationDetailsResult.md)\> +▸ **revocationDetails**(`credential`): `Promise`\<``null`` \| [`CredentialRevocationDetailsResult`](../interfaces/modules_verifiable_credentials.CredentialRevocationDetailsResult.md)\> Get the credentials revocation details. @@ -254,11 +258,11 @@ await verifiableCredentialsService.revocationDetails(credential); | Name | Type | Description | | :------ | :------ | :------ | -| `credential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential | +| `credential` | `VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential | #### Returns -`Promise`<``null`` \| [`CredentialRevocationDetailsResult`](../interfaces/modules_verifiable_credentials.CredentialRevocationDetailsResult.md)\> +`Promise`\<``null`` \| [`CredentialRevocationDetailsResult`](../interfaces/modules_verifiable_credentials.CredentialRevocationDetailsResult.md)\> revoker and revocationTimeStamp for the revocation @@ -266,7 +270,7 @@ ___ ### revokeCredential -▸ **revokeCredential**(`credential`): `Promise`<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> +▸ **revokeCredential**(`credential`): `Promise`\<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> Revoke given verifiable credential with StatusList2021. @@ -278,11 +282,11 @@ await verifiableCredentialsService.revokeCredential(credential); | Name | Type | Description | | :------ | :------ | :------ | -| `credential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential | +| `credential` | `VerifiableCredential`\<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential | #### Returns -`Promise`<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> +`Promise`\<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\> StatusList2021Credential @@ -290,7 +294,7 @@ ___ ### verify -▸ **verify**<`T`\>(`vcOrVp`, `options?`): `Promise`<`boolean`\> +▸ **verify**\<`T`\>(`vcOrVp`, `options?`): `Promise`\<`boolean`\> Verify a given credential or presentation. Throws an error if the credential or presentation proof is not valid. @@ -309,12 +313,12 @@ await verifiableCredentialsService.verify(presentation); | Name | Type | Description | | :------ | :------ | :------ | -| `vcOrVp` | `VerifiablePresentation` \| `VerifiableCredential`<`T`\> | verifiable presentation or credential | +| `vcOrVp` | `VerifiablePresentation` \| `VerifiableCredential`\<`T`\> | verifiable presentation or credential | | `options?` | [`ProofOptions`](../interfaces/modules_verifiable_credentials.ProofOptions.md) | proof options | #### Returns -`Promise`<`boolean`\> +`Promise`\<`boolean`\> true if the proof is valid @@ -322,7 +326,7 @@ ___ ### create -▸ `Static` **create**(`signerService`, `cacheClient`): `Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> +▸ **create**(`signerService`, `cacheClient`): `Promise`\<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> #### Parameters @@ -333,4 +337,4 @@ ___ #### Returns -`Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> +`Promise`\<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> diff --git a/docs/api/interfaces/modules_cache_client.ICacheClient.md b/docs/api/interfaces/modules_cache_client.ICacheClient.md index fbf1ceaf..f09f4617 100644 --- a/docs/api/interfaces/modules_cache_client.ICacheClient.md +++ b/docs/api/interfaces/modules_cache_client.ICacheClient.md @@ -47,11 +47,11 @@ ### addDIDToWatchList -• **addDIDToWatchList**: (`did`: `string`) => `Promise`<`void`\> +• **addDIDToWatchList**: (`did`: `string`) => `Promise`\<`void`\> #### Type declaration -▸ (`did`): `Promise`<`void`\> +▸ (`did`): `Promise`\<`void`\> ##### Parameters @@ -61,17 +61,17 @@ ##### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### deleteClaim -• **deleteClaim**: (`claimId`: `string`) => `Promise`<`void`\> +• **deleteClaim**: (`claimId`: `string`) => `Promise`\<`void`\> #### Type declaration -▸ (`claimId`): `Promise`<`void`\> +▸ (`claimId`): `Promise`\<`void`\> ##### Parameters @@ -81,17 +81,17 @@ ___ ##### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### getAppDefinition -• **getAppDefinition**: (`namespace`: `string`) => `Promise`<`IAppDefinition`\> +• **getAppDefinition**: (`namespace`: `string`) => `Promise`\<`IAppDefinition`\> #### Type declaration -▸ (`namespace`): `Promise`<`IAppDefinition`\> +▸ (`namespace`): `Promise`\<`IAppDefinition`\> ##### Parameters @@ -101,17 +101,17 @@ ___ ##### Returns -`Promise`<`IAppDefinition`\> +`Promise`\<`IAppDefinition`\> ___ ### getApplicationRoles -• **getApplicationRoles**: (`namespace`: `string`) => `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +• **getApplicationRoles**: (`namespace`: `string`) => `Promise`\<[`IRole`](modules_domains.IRole.md)[]\> #### Type declaration -▸ (`namespace`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +▸ (`namespace`): `Promise`\<[`IRole`](modules_domains.IRole.md)[]\> ##### Parameters @@ -121,17 +121,17 @@ ___ ##### Returns -`Promise`<[`IRole`](modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](modules_domains.IRole.md)[]\> ___ ### getApplicationsByOrganization -• **getApplicationsByOrganization**: (`namespace`: `string`) => `Promise`<[`IApp`](modules_domains.IApp.md)[]\> +• **getApplicationsByOrganization**: (`namespace`: `string`) => `Promise`\<[`IApp`](modules_domains.IApp.md)[]\> #### Type declaration -▸ (`namespace`): `Promise`<[`IApp`](modules_domains.IApp.md)[]\> +▸ (`namespace`): `Promise`\<[`IApp`](modules_domains.IApp.md)[]\> ##### Parameters @@ -141,17 +141,17 @@ ___ ##### Returns -`Promise`<[`IApp`](modules_domains.IApp.md)[]\> +`Promise`\<[`IApp`](modules_domains.IApp.md)[]\> ___ ### getApplicationsByOwner -• **getApplicationsByOwner**: (`owner`: `string`) => `Promise`<[`IApp`](modules_domains.IApp.md)[]\> +• **getApplicationsByOwner**: (`owner`: `string`) => `Promise`\<[`IApp`](modules_domains.IApp.md)[]\> #### Type declaration -▸ (`owner`): `Promise`<[`IApp`](modules_domains.IApp.md)[]\> +▸ (`owner`): `Promise`\<[`IApp`](modules_domains.IApp.md)[]\> ##### Parameters @@ -161,17 +161,17 @@ ___ ##### Returns -`Promise`<[`IApp`](modules_domains.IApp.md)[]\> +`Promise`\<[`IApp`](modules_domains.IApp.md)[]\> ___ ### getAssetById -• **getAssetById**: (`id`: `string`) => `Promise`<[`Asset`](modules_assets.Asset.md)\> +• **getAssetById**: (`id`: `string`) => `Promise`\<[`Asset`](modules_assets.Asset.md)\> #### Type declaration -▸ (`id`): `Promise`<[`Asset`](modules_assets.Asset.md)\> +▸ (`id`): `Promise`\<[`Asset`](modules_assets.Asset.md)\> ##### Parameters @@ -181,17 +181,17 @@ ___ ##### Returns -`Promise`<[`Asset`](modules_assets.Asset.md)\> +`Promise`\<[`Asset`](modules_assets.Asset.md)\> ___ ### getAssetHistory -• **getAssetHistory**: (`id`: `string`, `filter?`: [`AssetsFilter`](../modules/modules_cache_client.md#assetsfilter)) => `Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> +• **getAssetHistory**: (`id`: `string`, `filter?`: [`AssetsFilter`](../modules/modules_cache_client.md#assetsfilter)) => `Promise`\<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> #### Type declaration -▸ (`id`, `filter?`): `Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> +▸ (`id`, `filter?`): `Promise`\<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> ##### Parameters @@ -202,17 +202,17 @@ ___ ##### Returns -`Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> +`Promise`\<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> ___ ### getClaimById -• **getClaimById**: (`claimId`: `string`) => `Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> +• **getClaimById**: (`claimId`: `string`) => `Promise`\<`undefined` \| [`Claim`](modules_claims.Claim.md)\> #### Type declaration -▸ (`claimId`): `Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> +▸ (`claimId`): `Promise`\<`undefined` \| [`Claim`](modules_claims.Claim.md)\> ##### Parameters @@ -222,17 +222,17 @@ ___ ##### Returns -`Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> +`Promise`\<`undefined` \| [`Claim`](modules_claims.Claim.md)\> ___ ### getClaimsByIssuer -• **getClaimsByIssuer**: (`issuer`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +• **getClaimsByIssuer**: (`issuer`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> #### Type declaration -▸ (`issuer`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +▸ (`issuer`, `filter?`): `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ##### Parameters @@ -243,17 +243,17 @@ ___ ##### Returns -`Promise`<[`Claim`](modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ___ ### getClaimsByRequester -• **getClaimsByRequester**: (`requester`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +• **getClaimsByRequester**: (`requester`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> #### Type declaration -▸ (`requester`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +▸ (`requester`, `filter?`): `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ##### Parameters @@ -264,17 +264,17 @@ ___ ##### Returns -`Promise`<[`Claim`](modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ___ ### getClaimsByRevoker -• **getClaimsByRevoker**: (`revoker`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +• **getClaimsByRevoker**: (`revoker`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> #### Type declaration -▸ (`revoker`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +▸ (`revoker`, `filter?`): `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ##### Parameters @@ -285,17 +285,17 @@ ___ ##### Returns -`Promise`<[`Claim`](modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ___ ### getClaimsBySubject -• **getClaimsBySubject**: (`subject`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +• **getClaimsBySubject**: (`subject`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> #### Type declaration -▸ (`subject`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +▸ (`subject`, `filter?`): `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ##### Parameters @@ -306,17 +306,17 @@ ___ ##### Returns -`Promise`<[`Claim`](modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ___ ### getClaimsBySubjects -• **getClaimsBySubjects**: (`subjects`: `string`[]) => `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +• **getClaimsBySubjects**: (`subjects`: `string`[]) => `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> #### Type declaration -▸ (`subjects`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +▸ (`subjects`): `Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ##### Parameters @@ -326,17 +326,17 @@ ___ ##### Returns -`Promise`<[`Claim`](modules_claims.Claim.md)[]\> +`Promise`\<[`Claim`](modules_claims.Claim.md)[]\> ___ ### getDIDsForRole -• **getDIDsForRole**: (`namespace`: `string`) => `Promise`<`string`[]\> +• **getDIDsForRole**: (`namespace`: `string`) => `Promise`\<`string`[]\> #### Type declaration -▸ (`namespace`): `Promise`<`string`[]\> +▸ (`namespace`): `Promise`\<`string`[]\> ##### Parameters @@ -346,17 +346,17 @@ ___ ##### Returns -`Promise`<`string`[]\> +`Promise`\<`string`[]\> ___ ### getDidDocument -• **getDidDocument**: (`did`: `string`, `includeClaims?`: `boolean`) => `Promise`<`IDIDDocument`\> +• **getDidDocument**: (`did`: `string`, `includeClaims?`: `boolean`) => `Promise`\<`IDIDDocument`\> #### Type declaration -▸ (`did`, `includeClaims?`): `Promise`<`IDIDDocument`\> +▸ (`did`, `includeClaims?`): `Promise`\<`IDIDDocument`\> ##### Parameters @@ -367,17 +367,17 @@ ___ ##### Returns -`Promise`<`IDIDDocument`\> +`Promise`\<`IDIDDocument`\> ___ ### getNamespaceBySearchPhrase -• **getNamespaceBySearchPhrase**: (`phrase`: `string`, `types?`: [`SearchType`](../enums/modules_cache_client.SearchType.md)[]) => `Promise`<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> +• **getNamespaceBySearchPhrase**: (`phrase`: `string`, `types?`: [`SearchType`](../enums/modules_cache_client.SearchType.md)[]) => `Promise`\<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> #### Type declaration -▸ (`phrase`, `types?`): `Promise`<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> +▸ (`phrase`, `types?`): `Promise`\<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> ##### Parameters @@ -388,17 +388,17 @@ ___ ##### Returns -`Promise`<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> +`Promise`\<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> ___ ### getOfferedAssets -• **getOfferedAssets**: (`offeredTo`: `string`) => `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +• **getOfferedAssets**: (`offeredTo`: `string`) => `Promise`\<[`Asset`](modules_assets.Asset.md)[]\> #### Type declaration -▸ (`offeredTo`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +▸ (`offeredTo`): `Promise`\<[`Asset`](modules_assets.Asset.md)[]\> ##### Parameters @@ -408,17 +408,17 @@ ___ ##### Returns -`Promise`<[`Asset`](modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](modules_assets.Asset.md)[]\> ___ ### getOrgDefinition -• **getOrgDefinition**: (`namespace`: `string`) => `Promise`<`IOrganizationDefinition`\> +• **getOrgDefinition**: (`namespace`: `string`) => `Promise`\<`IOrganizationDefinition`\> #### Type declaration -▸ (`namespace`): `Promise`<`IOrganizationDefinition`\> +▸ (`namespace`): `Promise`\<`IOrganizationDefinition`\> ##### Parameters @@ -428,17 +428,17 @@ ___ ##### Returns -`Promise`<`IOrganizationDefinition`\> +`Promise`\<`IOrganizationDefinition`\> ___ ### getOrgHierarchy -• **getOrgHierarchy**: (`namespace`: `string`) => `Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> +• **getOrgHierarchy**: (`namespace`: `string`) => `Promise`\<[`IOrganization`](modules_domains.IOrganization.md)\> #### Type declaration -▸ (`namespace`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> +▸ (`namespace`): `Promise`\<[`IOrganization`](modules_domains.IOrganization.md)\> ##### Parameters @@ -448,17 +448,17 @@ ___ ##### Returns -`Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> +`Promise`\<[`IOrganization`](modules_domains.IOrganization.md)\> ___ ### getOrganizationRoles -• **getOrganizationRoles**: (`namespace`: `string`) => `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +• **getOrganizationRoles**: (`namespace`: `string`) => `Promise`\<[`IRole`](modules_domains.IRole.md)[]\> #### Type declaration -▸ (`namespace`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +▸ (`namespace`): `Promise`\<[`IRole`](modules_domains.IRole.md)[]\> ##### Parameters @@ -468,17 +468,17 @@ ___ ##### Returns -`Promise`<[`IRole`](modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](modules_domains.IRole.md)[]\> ___ ### getOrganizationsByOwner -• **getOrganizationsByOwner**: (`owner`: `string`, `excludeSubOrgs?`: `boolean`) => `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> +• **getOrganizationsByOwner**: (`owner`: `string`, `excludeSubOrgs?`: `boolean`) => `Promise`\<[`IOrganization`](modules_domains.IOrganization.md)[]\> #### Type declaration -▸ (`owner`, `excludeSubOrgs?`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> +▸ (`owner`, `excludeSubOrgs?`): `Promise`\<[`IOrganization`](modules_domains.IOrganization.md)[]\> ##### Parameters @@ -489,17 +489,17 @@ ___ ##### Returns -`Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> +`Promise`\<[`IOrganization`](modules_domains.IOrganization.md)[]\> ___ ### getOwnedAssets -• **getOwnedAssets**: (`owner`: `string`) => `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +• **getOwnedAssets**: (`owner`: `string`) => `Promise`\<[`Asset`](modules_assets.Asset.md)[]\> #### Type declaration -▸ (`owner`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +▸ (`owner`): `Promise`\<[`Asset`](modules_assets.Asset.md)[]\> ##### Parameters @@ -509,17 +509,17 @@ ___ ##### Returns -`Promise`<[`Asset`](modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](modules_assets.Asset.md)[]\> ___ ### getPreviouslyOwnedAssets -• **getPreviouslyOwnedAssets**: (`owner`: `string`) => `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +• **getPreviouslyOwnedAssets**: (`owner`: `string`) => `Promise`\<[`Asset`](modules_assets.Asset.md)[]\> #### Type declaration -▸ (`owner`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +▸ (`owner`): `Promise`\<[`Asset`](modules_assets.Asset.md)[]\> ##### Parameters @@ -529,17 +529,17 @@ ___ ##### Returns -`Promise`<[`Asset`](modules_assets.Asset.md)[]\> +`Promise`\<[`Asset`](modules_assets.Asset.md)[]\> ___ ### getRoleDefinition -• **getRoleDefinition**: (`namespace`: `string`) => `Promise`<`IRoleDefinition`\> +• **getRoleDefinition**: (`namespace`: `string`) => `Promise`\<`IRoleDefinition`\> #### Type declaration -▸ (`namespace`): `Promise`<`IRoleDefinition`\> +▸ (`namespace`): `Promise`\<`IRoleDefinition`\> ##### Parameters @@ -549,17 +549,17 @@ ___ ##### Returns -`Promise`<`IRoleDefinition`\> +`Promise`\<`IRoleDefinition`\> ___ ### getRolesByOwner -• **getRolesByOwner**: (`owner`: `string`) => `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +• **getRolesByOwner**: (`owner`: `string`) => `Promise`\<[`IRole`](modules_domains.IRole.md)[]\> #### Type declaration -▸ (`owner`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +▸ (`owner`): `Promise`\<[`IRole`](modules_domains.IRole.md)[]\> ##### Parameters @@ -569,17 +569,17 @@ ___ ##### Returns -`Promise`<[`IRole`](modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](modules_domains.IRole.md)[]\> ___ ### getRolesByRevoker -• **getRolesByRevoker**: (`revoker`: `string`) => `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +• **getRolesByRevoker**: (`revoker`: `string`) => `Promise`\<[`IRole`](modules_domains.IRole.md)[]\> #### Type declaration -▸ (`revoker`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +▸ (`revoker`): `Promise`\<[`IRole`](modules_domains.IRole.md)[]\> ##### Parameters @@ -589,17 +589,17 @@ ___ ##### Returns -`Promise`<[`IRole`](modules_domains.IRole.md)[]\> +`Promise`\<[`IRole`](modules_domains.IRole.md)[]\> ___ ### getRolesDefinition -• **getRolesDefinition**: (`namespace`: `string`[]) => `Promise`<`Record`<`string`, `IRoleDefinition`\>\> +• **getRolesDefinition**: (`namespace`: `string`[]) => `Promise`\<`Record`\<`string`, `IRoleDefinition`\>\> #### Type declaration -▸ (`namespace`): `Promise`<`Record`<`string`, `IRoleDefinition`\>\> +▸ (`namespace`): `Promise`\<`Record`\<`string`, `IRoleDefinition`\>\> ##### Parameters @@ -609,17 +609,17 @@ ___ ##### Returns -`Promise`<`Record`<`string`, `IRoleDefinition`\>\> +`Promise`\<`Record`\<`string`, `IRoleDefinition`\>\> ___ ### getSubOrganizationsByOrganization -• **getSubOrganizationsByOrganization**: (`namespace`: `string`) => `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> +• **getSubOrganizationsByOrganization**: (`namespace`: `string`) => `Promise`\<[`IOrganization`](modules_domains.IOrganization.md)[]\> #### Type declaration -▸ (`namespace`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> +▸ (`namespace`): `Promise`\<[`IOrganization`](modules_domains.IOrganization.md)[]\> ##### Parameters @@ -629,17 +629,17 @@ ___ ##### Returns -`Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> +`Promise`\<[`IOrganization`](modules_domains.IOrganization.md)[]\> ___ ### issueClaim -• **issueClaim**: (`issuer`: `string`, `message`: [`IClaimIssuance`](modules_claims.IClaimIssuance.md)) => `Promise`<`void`\> +• **issueClaim**: (`issuer`: `string`, `message`: [`IClaimIssuance`](modules_claims.IClaimIssuance.md)) => `Promise`\<`void`\> #### Type declaration -▸ (`issuer`, `message`): `Promise`<`void`\> +▸ (`issuer`, `message`): `Promise`\<`void`\> ##### Parameters @@ -650,17 +650,17 @@ ___ ##### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### rejectClaim -• **rejectClaim**: (`issuer`: `string`, `message`: [`IClaimRejection`](modules_claims.IClaimRejection.md)) => `Promise`<`void`\> +• **rejectClaim**: (`issuer`: `string`, `message`: [`IClaimRejection`](modules_claims.IClaimRejection.md)) => `Promise`\<`void`\> #### Type declaration -▸ (`issuer`, `message`): `Promise`<`void`\> +▸ (`issuer`, `message`): `Promise`\<`void`\> ##### Parameters @@ -671,17 +671,17 @@ ___ ##### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ ### requestClaim -• **requestClaim**: (`message`: [`IClaimRequest`](modules_claims.IClaimRequest.md)) => `Promise`<`void`\> +• **requestClaim**: (`message`: [`IClaimRequest`](modules_claims.IClaimRequest.md)) => `Promise`\<`void`\> #### Type declaration -▸ (`message`): `Promise`<`void`\> +▸ (`message`): `Promise`\<`void`\> ##### Parameters @@ -691,4 +691,4 @@ ___ ##### Returns -`Promise`<`void`\> +`Promise`\<`void`\> diff --git a/docs/api/interfaces/modules_claims.CreateSelfSignedClaimOptions.md b/docs/api/interfaces/modules_claims.CreateSelfSignedClaimOptions.md index a7e838f8..d605a9e3 100644 --- a/docs/api/interfaces/modules_claims.CreateSelfSignedClaimOptions.md +++ b/docs/api/interfaces/modules_claims.CreateSelfSignedClaimOptions.md @@ -13,7 +13,7 @@ ### data -• **data**: `Record`<`string`, `unknown`\> +• **data**: `Record`\<`string`, `unknown`\> Claim data diff --git a/docs/api/interfaces/modules_claims.RevokeMultipleClaimOptions.md b/docs/api/interfaces/modules_claims.RevokeMultipleClaimOptions.md index e2c67964..9b9f02c2 100644 --- a/docs/api/interfaces/modules_claims.RevokeMultipleClaimOptions.md +++ b/docs/api/interfaces/modules_claims.RevokeMultipleClaimOptions.md @@ -21,4 +21,4 @@ ___ ### claims -• `Optional` **claims**: { `namespace`: `string` ; `subject`: `string` }[] +• `Optional` **claims**: \{ `namespace`: `string` ; `subject`: `string` }[] diff --git a/docs/api/interfaces/modules_did_registry.CreatePublicClaimOptions.md b/docs/api/interfaces/modules_did_registry.CreatePublicClaimOptions.md index 05fa2d3e..0e4e505c 100644 --- a/docs/api/interfaces/modules_did_registry.CreatePublicClaimOptions.md +++ b/docs/api/interfaces/modules_did_registry.CreatePublicClaimOptions.md @@ -13,7 +13,7 @@ ### data -• **data**: `Record`<`string`, `unknown`\> +• **data**: `Record`\<`string`, `unknown`\> ___ diff --git a/docs/api/interfaces/modules_did_registry.IpfsConfig.md b/docs/api/interfaces/modules_did_registry.IpfsConfig.md index 48934614..b5fb3cd2 100644 --- a/docs/api/interfaces/modules_did_registry.IpfsConfig.md +++ b/docs/api/interfaces/modules_did_registry.IpfsConfig.md @@ -15,7 +15,7 @@ ### headers -• `Optional` **headers**: `Record`<`string`, `any`\> +• `Optional` **headers**: `Record`\<`string`, `any`\> ___ diff --git a/docs/api/interfaces/modules_domains.ReturnStep.md b/docs/api/interfaces/modules_domains.ReturnStep.md index 07a517ed..b05ddfbe 100644 --- a/docs/api/interfaces/modules_domains.ReturnStep.md +++ b/docs/api/interfaces/modules_domains.ReturnStep.md @@ -20,15 +20,15 @@ ___ ### next -• **next**: () => `Promise`<`void`\> +• **next**: () => `Promise`\<`void`\> #### Type declaration -▸ (): `Promise`<`void`\> +▸ (): `Promise`\<`void`\> ##### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ diff --git a/docs/api/interfaces/modules_domains.ReturnStepWithRetryCheck.md b/docs/api/interfaces/modules_domains.ReturnStepWithRetryCheck.md index 94e95a6e..08dfb282 100644 --- a/docs/api/interfaces/modules_domains.ReturnStepWithRetryCheck.md +++ b/docs/api/interfaces/modules_domains.ReturnStepWithRetryCheck.md @@ -20,11 +20,11 @@ ___ ### next -• **next**: (`opt?`: { `retryCheck?`: `boolean` }) => `Promise`<`undefined` \| `TransactionReceipt`\> +• **next**: (`opt?`: \{ `retryCheck?`: `boolean` }) => `Promise`\<`undefined` \| `TransactionReceipt`\> #### Type declaration -▸ (`opt?`): `Promise`<`undefined` \| `TransactionReceipt`\> +▸ (`opt?`): `Promise`\<`undefined` \| `TransactionReceipt`\> ##### Parameters @@ -35,7 +35,7 @@ ___ ##### Returns -`Promise`<`undefined` \| `TransactionReceipt`\> +`Promise`\<`undefined` \| `TransactionReceipt`\> ___ diff --git a/docs/api/interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md b/docs/api/interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md index fb6c13e7..5e315f8e 100644 --- a/docs/api/interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md +++ b/docs/api/interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md @@ -17,7 +17,7 @@ ### @context -• **@context**: (`string` \| `Record`<`string`, `unknown`\>)[] +• **@context**: (`string` \| `Record`\<`string`, `unknown`\>)[] ___ diff --git a/docs/api/modules/init.md b/docs/api/modules/init.md index f17c4cb7..6cab3f12 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`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> +▸ **init**(`signerService`): `Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> Initializes messaging service and creates initializer of cache client @@ -28,13 +28,13 @@ Initializes messaging service and creates initializer of cache client #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> +`Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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**(`proxyUrl?`): `Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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 @@ -44,13 +44,13 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> +`Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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**(`safeAppSdk`): `Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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 @@ -60,13 +60,13 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> +`Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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**(`«destructured»?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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**(`«destructured»?`): `Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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 @@ -78,23 +78,23 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> +`Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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**(): `Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> +`Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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**(`privateKey`, `rpcUrl`): `Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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 @@ -105,13 +105,13 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> +`Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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**(`bridge?`): `Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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 @@ -121,4 +121,4 @@ ___ #### Returns -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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) }\> +`Promise`\<\{ `connectToCacheServer`: () => `Promise`\<\{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cache_client.CacheClient.md) ; `connectToDidRegistry`: (`ipfsConfig`: [`IpfsConfig`](../interfaces/modules_did_registry.IpfsConfig.md)) => `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_claims.md b/docs/api/modules/modules_claims.md index 9bb25363..26dc583e 100644 --- a/docs/api/modules/modules_claims.md +++ b/docs/api/modules/modules_claims.md @@ -134,7 +134,7 @@ ___ ### readyToBeRegisteredOnchain -▸ **readyToBeRegisteredOnchain**(`claim`): claim is Required & Object\> +▸ **readyToBeRegisteredOnchain**(`claim`): claim is Required\ & Object\> #### Parameters @@ -144,4 +144,4 @@ ___ #### Returns -claim is Required & Object\> +claim is Required\ & Object\> diff --git a/docs/api/modules/modules_did_registry.md b/docs/api/modules/modules_did_registry.md index 10daa703..17f28a84 100644 --- a/docs/api/modules/modules_did_registry.md +++ b/docs/api/modules/modules_did_registry.md @@ -33,7 +33,7 @@ ### isClaimService -▸ **isClaimService**(`service`): service is IServiceEndpoint & Pick +▸ **isClaimService**(`service`): service is IServiceEndpoint & Pick\ #### Parameters @@ -43,4 +43,4 @@ #### Returns -service is IServiceEndpoint & Pick +service is IServiceEndpoint & Pick\ diff --git a/docs/api/modules/modules_domains.md b/docs/api/modules/modules_domains.md index 13dffe62..143761cc 100644 --- a/docs/api/modules/modules_domains.md +++ b/docs/api/modules/modules_domains.md @@ -58,7 +58,7 @@ ___ ### MulticallTx -Ƭ **MulticallTx**: { `info`: `string` ; `next`: (`opts?`: { `retryCheck?`: `boolean` }) => `Promise`<`providers.TransactionReceipt` \| `undefined`\> ; `tx`: `EncodedCall` }[] +Ƭ **MulticallTx**: \{ `info`: `string` ; `next`: (`opts?`: \{ `retryCheck?`: `boolean` }) => `Promise`\<`providers.TransactionReceipt` \| `undefined`\> ; `tx`: `EncodedCall` }[] ## Variables diff --git a/docs/api/modules/modules_signer.md b/docs/api/modules/modules_signer.md index 43d75f97..fd816fe4 100644 --- a/docs/api/modules/modules_signer.md +++ b/docs/api/modules/modules_signer.md @@ -55,15 +55,15 @@ ___ ### ServiceInitializer -Ƭ **ServiceInitializer**: () => `Promise`<`void`\> +Ƭ **ServiceInitializer**: () => `Promise`\<`void`\> #### Type declaration -▸ (): `Promise`<`void`\> +▸ (): `Promise`\<`void`\> ##### Returns -`Promise`<`void`\> +`Promise`\<`void`\> ___ @@ -104,12 +104,7 @@ ___ ### fromGnosis -▸ **fromGnosis**(`safeAppSdk`): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> - -**`Description`** - -Intended for use in Volta Gnosis web interface(https://volta.gnosis-safe.io/). -Dapp should provide SafeAppSdk injected by Gnosis interface +▸ **fromGnosis**(`safeAppSdk`): `Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> #### Parameters @@ -119,13 +114,18 @@ Dapp should provide SafeAppSdk injected by Gnosis interface #### Returns -`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +`Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +**`Description`** + +Intended for use in Volta Gnosis web interface(https://volta.gnosis-safe.io/). +Dapp should provide SafeAppSdk injected by Gnosis interface ___ ### fromKms -▸ **fromKms**(`bridge`, `kmsServerUrl`, `infuraId?`): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +▸ **fromKms**(`bridge`, `kmsServerUrl`, `infuraId?`): `Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> #### Parameters @@ -137,23 +137,23 @@ ___ #### Returns -`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +`Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> ___ ### fromMetaMask -▸ **fromMetaMask**(): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +▸ **fromMetaMask**(): `Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> #### Returns -`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +`Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> ___ ### fromPrivateKey -▸ **fromPrivateKey**(`privateKey`, `rpcUrl`): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +▸ **fromPrivateKey**(`privateKey`, `rpcUrl`): `Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> #### Parameters @@ -164,13 +164,13 @@ ___ #### Returns -`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +`Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> ___ ### fromWalletConnectMetamask -▸ **fromWalletConnectMetamask**(`bridge`, `infuraId?`): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +▸ **fromWalletConnectMetamask**(`bridge`, `infuraId?`): `Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> #### Parameters @@ -181,14 +181,14 @@ ___ #### Returns -`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> +`Promise`\<[`SignerService`](../classes/modules_signer.SignerService.md)\> ___ ### isMetamaskExtensionPresent -▸ **isMetamaskExtensionPresent**(): `Promise`<{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\> +▸ **isMetamaskExtensionPresent**(): `Promise`\<\{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\> #### Returns -`Promise`<{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\> +`Promise`\<\{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\> diff --git a/docs/api/modules/modules_verifiable_credentials.md b/docs/api/modules/modules_verifiable_credentials.md index 03c22e13..bf881a41 100644 --- a/docs/api/modules/modules_verifiable_credentials.md +++ b/docs/api/modules/modules_verifiable_credentials.md @@ -40,7 +40,7 @@ ### StatusList2021Credential -Ƭ **StatusList2021Credential**: `VerifiableCredential`<[`StatusList2021CredentialSubject`](../interfaces/modules_verifiable_credentials.StatusList2021CredentialSubject.md)\> +Ƭ **StatusList2021Credential**: `VerifiableCredential`\<[`StatusList2021CredentialSubject`](../interfaces/modules_verifiable_credentials.StatusList2021CredentialSubject.md)\> ## Variables @@ -53,9 +53,9 @@ | Name | Type | | :------ | :------ | | `EIP712Domain` | `never`[] | -| `Proof` | { `name`: `string` = '@context'; `type`: `string` = 'string' }[] | -| `StatusList2021` | { `name`: `string` = 'id'; `type`: `string` = 'string' }[] | -| `VerifiableCredential` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | +| `Proof` | \{ `name`: `string` = '@context'; `type`: `string` = 'string' }[] | +| `StatusList2021` | \{ `name`: `string` = 'id'; `type`: `string` = 'string' }[] | +| `VerifiableCredential` | \{ `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | ___ @@ -67,13 +67,13 @@ ___ | Name | Type | | :------ | :------ | -| `CredentialSubject` | { `name`: `string` = 'id'; `type`: `string` = 'string' }[] | +| `CredentialSubject` | \{ `name`: `string` = 'id'; `type`: `string` = 'string' }[] | | `EIP712Domain` | `never`[] | -| `EWFRole` | { `name`: `string` = 'namespace'; `type`: `string` = 'string' }[] | -| `IssuerFields` | { `name`: `string` = 'key'; `type`: `string` = 'string' }[] | -| `Proof` | { `name`: `string` = '@context'; `type`: `string` = 'string' }[] | -| `StatusList2021Entry` | { `name`: `string` = 'id'; `type`: `string` = 'string' }[] | -| `VerifiableCredential` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | +| `EWFRole` | \{ `name`: `string` = 'namespace'; `type`: `string` = 'string' }[] | +| `IssuerFields` | \{ `name`: `string` = 'key'; `type`: `string` = 'string' }[] | +| `Proof` | \{ `name`: `string` = '@context'; `type`: `string` = 'string' }[] | +| `StatusList2021Entry` | \{ `name`: `string` = 'id'; `type`: `string` = 'string' }[] | +| `VerifiableCredential` | \{ `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | ___ @@ -86,8 +86,8 @@ ___ | Name | Type | | :------ | :------ | | `EIP712Domain` | `never`[] | -| `Proof` | { `name`: `string` = '@context'; `type`: `string` = 'string' }[] | -| `VerifiablePresentation` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | +| `Proof` | \{ `name`: `string` = '@context'; `type`: `string` = 'string' }[] | +| `VerifiablePresentation` | \{ `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | ___ @@ -99,25 +99,25 @@ ___ | Name | Type | | :------ | :------ | -| `CredentialSubject` | { `name`: `string` = 'id'; `type`: `string` = 'string' }[] | +| `CredentialSubject` | \{ `name`: `string` = 'id'; `type`: `string` = 'string' }[] | | `EIP712Domain` | `never`[] | -| `EWFRole` | { `name`: `string` = 'namespace'; `type`: `string` = 'string' }[] | -| `IssuerFields` | { `name`: `string` = 'key'; `type`: `string` = 'string' }[] | -| `Proof` | { `name`: `string` = '@context'; `type`: `string` = 'string' }[] | -| `StatusList2021Entry` | { `name`: `string` = 'id'; `type`: `string` = 'string' }[] | -| `VC712Domain` | { `name`: `string` = 'domain'; `type`: `string` = 'VC712DomainData' }[] | +| `EWFRole` | \{ `name`: `string` = 'namespace'; `type`: `string` = 'string' }[] | +| `IssuerFields` | \{ `name`: `string` = 'key'; `type`: `string` = 'string' }[] | +| `Proof` | \{ `name`: `string` = '@context'; `type`: `string` = 'string' }[] | +| `StatusList2021Entry` | \{ `name`: `string` = 'id'; `type`: `string` = 'string' }[] | +| `VC712Domain` | \{ `name`: `string` = 'domain'; `type`: `string` = 'VC712DomainData' }[] | | `VC712DomainData` | `never`[] | -| `VC712DomainSchema` | { `name`: `string` = 'StatusList2021Entry'; `type`: `string` = 'VC712DomainTypedDataField[]' }[] | -| `VC712DomainTypedDataField` | { `name`: `string` = 'name'; `type`: `string` = 'string' }[] | -| `VCProof` | { `name`: `string` = '@context'; `type`: `string` = 'string' }[] | -| `VerifiableCredential` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | -| `VerifiablePresentation` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | +| `VC712DomainSchema` | \{ `name`: `string` = 'StatusList2021Entry'; `type`: `string` = 'VC712DomainTypedDataField[]' }[] | +| `VC712DomainTypedDataField` | \{ `name`: `string` = 'name'; `type`: `string` = 'string' }[] | +| `VCProof` | \{ `name`: `string` = '@context'; `type`: `string` = 'string' }[] | +| `VerifiableCredential` | \{ `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | +| `VerifiablePresentation` | \{ `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | ## Functions ### getVerifiableCredentialsService -▸ **getVerifiableCredentialsService**(`signerService`, `cacheClient`): `Promise`<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> +▸ **getVerifiableCredentialsService**(`signerService`, `cacheClient`): `Promise`\<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> #### Parameters @@ -128,23 +128,23 @@ ___ #### Returns -`Promise`<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> +`Promise`\<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> ___ ### isRoleCredential -▸ **isRoleCredential**(`credential`): credential is VerifiableCredential +▸ **isRoleCredential**(`credential`): credential is VerifiableCredential\ #### Parameters | Name | Type | | :------ | :------ | -| `credential` | `VerifiableCredential`<`ICredentialSubject`\> | +| `credential` | `VerifiableCredential`\<`ICredentialSubject`\> | #### Returns -credential is VerifiableCredential +credential is VerifiableCredential\ ___ diff --git a/package.json b/package.json index 8209ffc2..fb407186 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "iam-client-lib", - "version": "8.1.1", + "version": "8.1.2-alpha.1", "description": "Library for Decentralized Identity and Access Management", "main": "lib/index.js", "module": "lib.esm/index.js", diff --git a/src/modules/auth/auth.service.ts b/src/modules/auth/auth.service.ts index e50acf45..c7429b6a 100644 --- a/src/modules/auth/auth.service.ts +++ b/src/modules/auth/auth.service.ts @@ -248,6 +248,10 @@ export class AuthService { try { await this.authenticatePromise; + if (config.headers) { + config.headers.Authorization = + this.httpClient.defaults.headers.common['Authorization']; + } } finally { this.isAuthenticating = false; }