diff --git a/docs/api/classes/modules_cache_client.CacheClient.md b/docs/api/classes/modules_cache_client.CacheClient.md index 32913c9d..63a7b7fa 100644 --- a/docs/api/classes/modules_cache_client.CacheClient.md +++ b/docs/api/classes/modules_cache_client.CacheClient.md @@ -115,7 +115,7 @@ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[addDIDToWatchList](../interfaces/modules_cache_client.ICacheClient.md#adddidtowatchlist) +ICacheClient.addDIDToWatchList ___ @@ -143,7 +143,9 @@ ___ ▸ **authenticate**(): `Promise`<`void`\> -**`description`** Refreshes access token. If login still fails then signs new identity token and requests access token +**`Description`** + +Refreshes access token. If login still fails then signs new identity token and requests access token After authentication runs previously failed requests #### Returns @@ -168,7 +170,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[deleteClaim](../interfaces/modules_cache_client.ICacheClient.md#deleteclaim) +ICacheClient.deleteClaim ___ @@ -204,7 +206,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getAppDefinition](../interfaces/modules_cache_client.ICacheClient.md#getappdefinition) +ICacheClient.getAppDefinition ___ @@ -224,7 +226,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getApplicationRoles](../interfaces/modules_cache_client.ICacheClient.md#getapplicationroles) +ICacheClient.getApplicationRoles ___ @@ -244,7 +246,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getApplicationsByOrganization](../interfaces/modules_cache_client.ICacheClient.md#getapplicationsbyorganization) +ICacheClient.getApplicationsByOrganization ___ @@ -265,7 +267,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getApplicationsByOwner](../interfaces/modules_cache_client.ICacheClient.md#getapplicationsbyowner) +ICacheClient.getApplicationsByOwner ___ @@ -285,7 +287,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getAssetById](../interfaces/modules_cache_client.ICacheClient.md#getassetbyid) +ICacheClient.getAssetById ___ @@ -306,7 +308,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getAssetHistory](../interfaces/modules_cache_client.ICacheClient.md#getassethistory) +ICacheClient.getAssetHistory ___ @@ -326,7 +328,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getClaimById](../interfaces/modules_cache_client.ICacheClient.md#getclaimbyid) +ICacheClient.getClaimById ___ @@ -347,7 +349,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getClaimsByIssuer](../interfaces/modules_cache_client.ICacheClient.md#getclaimsbyissuer) +ICacheClient.getClaimsByIssuer ___ @@ -368,7 +370,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getClaimsByRequester](../interfaces/modules_cache_client.ICacheClient.md#getclaimsbyrequester) +ICacheClient.getClaimsByRequester ___ @@ -389,7 +391,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getClaimsByRevoker](../interfaces/modules_cache_client.ICacheClient.md#getclaimsbyrevoker) +ICacheClient.getClaimsByRevoker ___ @@ -410,7 +412,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getClaimsBySubject](../interfaces/modules_cache_client.ICacheClient.md#getclaimsbysubject) +ICacheClient.getClaimsBySubject ___ @@ -430,7 +432,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getClaimsBySubjects](../interfaces/modules_cache_client.ICacheClient.md#getclaimsbysubjects) +ICacheClient.getClaimsBySubjects ___ @@ -450,7 +452,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getDIDsForRole](../interfaces/modules_cache_client.ICacheClient.md#getdidsforrole) +ICacheClient.getDIDsForRole ___ @@ -471,7 +473,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getDidDocument](../interfaces/modules_cache_client.ICacheClient.md#getdiddocument) +ICacheClient.getDidDocument ___ @@ -492,7 +494,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getNamespaceBySearchPhrase](../interfaces/modules_cache_client.ICacheClient.md#getnamespacebysearchphrase) +ICacheClient.getNamespaceBySearchPhrase ___ @@ -512,7 +514,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getOfferedAssets](../interfaces/modules_cache_client.ICacheClient.md#getofferedassets) +ICacheClient.getOfferedAssets ___ @@ -532,7 +534,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getOrgDefinition](../interfaces/modules_cache_client.ICacheClient.md#getorgdefinition) +ICacheClient.getOrgDefinition ___ @@ -552,7 +554,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getOrgHierarchy](../interfaces/modules_cache_client.ICacheClient.md#getorghierarchy) +ICacheClient.getOrgHierarchy ___ @@ -572,7 +574,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getOrganizationRoles](../interfaces/modules_cache_client.ICacheClient.md#getorganizationroles) +ICacheClient.getOrganizationRoles ___ @@ -593,7 +595,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getOrganizationsByOwner](../interfaces/modules_cache_client.ICacheClient.md#getorganizationsbyowner) +ICacheClient.getOrganizationsByOwner ___ @@ -613,7 +615,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getOwnedAssets](../interfaces/modules_cache_client.ICacheClient.md#getownedassets) +ICacheClient.getOwnedAssets ___ @@ -633,7 +635,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getPreviouslyOwnedAssets](../interfaces/modules_cache_client.ICacheClient.md#getpreviouslyownedassets) +ICacheClient.getPreviouslyOwnedAssets ___ @@ -653,7 +655,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getRoleDefinition](../interfaces/modules_cache_client.ICacheClient.md#getroledefinition) +ICacheClient.getRoleDefinition ___ @@ -673,7 +675,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getRolesByOwner](../interfaces/modules_cache_client.ICacheClient.md#getrolesbyowner) +ICacheClient.getRolesByOwner ___ @@ -693,7 +695,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getRolesByRevoker](../interfaces/modules_cache_client.ICacheClient.md#getrolesbyrevoker) +ICacheClient.getRolesByRevoker ___ @@ -713,7 +715,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getRolesDefinition](../interfaces/modules_cache_client.ICacheClient.md#getrolesdefinition) +ICacheClient.getRolesDefinition ___ @@ -753,7 +755,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getSubOrganizationsByOrganization](../interfaces/modules_cache_client.ICacheClient.md#getsuborganizationsbyorganization) +ICacheClient.getSubOrganizationsByOrganization ___ @@ -761,7 +763,9 @@ ___ ▸ **handleError**(`error`): `Promise`<`unknown`\> -**`description`** Interceptor of authentication errors. Queues failed requests and starts authentication process. +**`Description`** + +Interceptor of authentication errors. Queues failed requests and starts authentication process. #### Parameters @@ -817,7 +821,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[isAuthEnabled](../interfaces/modules_cache_client.ICacheClient.md#isauthenabled) +ICacheClient.isAuthEnabled ___ @@ -838,7 +842,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[issueClaim](../interfaces/modules_cache_client.ICacheClient.md#issueclaim) +ICacheClient.issueClaim ___ @@ -855,7 +859,7 @@ https://energyweb.atlassian.net/wiki/spaces/MYEN/pages/2303295607/ICL-+ICS+Auth+ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[login](../interfaces/modules_cache_client.ICacheClient.md#login) +ICacheClient.login ___ @@ -896,7 +900,7 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[rejectClaim](../interfaces/modules_cache_client.ICacheClient.md#rejectclaim) +ICacheClient.rejectClaim ___ @@ -916,4 +920,4 @@ ___ #### Implementation of -[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[requestClaim](../interfaces/modules_cache_client.ICacheClient.md#requestclaim) +ICacheClient.requestClaim diff --git a/docs/api/classes/modules_claims.ClaimsService.md b/docs/api/classes/modules_claims.ClaimsService.md index da0c70ec..84b21547 100644 --- a/docs/api/classes/modules_claims.ClaimsService.md +++ b/docs/api/classes/modules_claims.ClaimsService.md @@ -46,7 +46,7 @@ claimsService.getClaimById(claim.id); - [resolveCredentialAndVerify](modules_claims.ClaimsService.md#resolvecredentialandverify) - [revokeClaim](modules_claims.ClaimsService.md#revokeclaim) - [revokeMultipleClaim](modules_claims.ClaimsService.md#revokemultipleclaim) -- [verifyOffChainClaim](modules_claims.ClaimsService.md#verifyoffchainclaim) +- [verifyRoleEIP191JWT](modules_claims.ClaimsService.md#verifyroleeip191jwt) - [verifyVc](modules_claims.ClaimsService.md#verifyvc) - [create](modules_claims.ClaimsService.md#create) @@ -792,9 +792,9 @@ claimsService.revokeMultipleClaim({ ___ -### verifyOffChainClaim +### verifyRoleEIP191JWT -▸ **verifyOffChainClaim**(`offChainClaim`): `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 @@ -804,7 +804,7 @@ Verifies: | Name | Type | | :------ | :------ | -| `offChainClaim` | `RoleEIP191JWT` | +| `roleEIP191JWT` | `RoleEIP191JWT` | #### Returns diff --git a/docs/api/classes/modules_signer.SignerService.md b/docs/api/classes/modules_signer.SignerService.md index 41d2025c..f5897ed5 100644 --- a/docs/api/classes/modules_signer.SignerService.md +++ b/docs/api/classes/modules_signer.SignerService.md @@ -353,7 +353,9 @@ ___ Add event handler for certain events -**`requires`** to be called after the connection to wallet was initialized +**`Requires`** + +to be called after the connection to wallet was initialized #### Returns diff --git a/docs/api/classes/modules_staking.StakingFactoryService.md b/docs/api/classes/modules_staking.StakingFactoryService.md index 4b7e8b36..c99d9dc1 100644 --- a/docs/api/classes/modules_staking.StakingFactoryService.md +++ b/docs/api/classes/modules_staking.StakingFactoryService.md @@ -35,7 +35,9 @@ Intended for staking pool ▸ **allServices**(): `Promise`<[`Service`](../modules/modules_staking.md#service)[]\> -**`description`** Returns all services for which pools are launched +**`Description`** + +Returns all services for which pools are launched #### Returns @@ -47,7 +49,9 @@ ___ ▸ **getPool**(): `Promise`<[`StakingPoolService`](modules_staking.StakingPoolService.md)\> -**`description`** Returns pool launched for energyweb org +**`Description`** + +Returns pool launched for energyweb org #### Returns diff --git a/docs/api/classes/modules_staking.StakingPoolService.md b/docs/api/classes/modules_staking.StakingPoolService.md index 930ec37f..008ba397 100644 --- a/docs/api/classes/modules_staking.StakingPoolService.md +++ b/docs/api/classes/modules_staking.StakingPoolService.md @@ -127,7 +127,7 @@ ___ ▸ **partialWithdraw**(`value`): `Promise`<`ContractReceipt`\> -**`description`** +**`Description`** #### Parameters @@ -145,9 +145,13 @@ ___ ▸ **putStake**(`stake`): `Promise`<`void`\> -**`description`** Locks stake and starts accumulating reward +**`Description`** -**`emits`** StakingPool.StakePut +Locks stake and starts accumulating reward + +**`Emits`** + +StakingPool.StakePut #### Parameters @@ -165,7 +169,9 @@ ___ ▸ **withdraw**(): `Promise`<`void`\> -**`description`** pays back stake with accumulated reward. +**`Description`** + +pays back stake with accumulated reward. #### Returns diff --git a/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md b/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md index 99b208ae..75aaeb6d 100644 --- a/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md +++ b/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md @@ -50,7 +50,9 @@ verifiableCredentialsService.createRoleVC(...); ▸ **continueExchange**(`__namedParameters`): `Promise`<`undefined` \| `VerifiablePresentation` \| `VpRequest`\> -**`description`** Sends credentials requested by issuer and returns either issued credentials or next credentials request +**`Description`** + +Sends credentials requested by issuer and returns either issued credentials or next credentials request #### Parameters diff --git a/docs/api/enums/modules_assets.AssetHistoryEventType.md b/docs/api/enums/modules_assets.AssetHistoryEventType.md index 00381638..c68babca 100644 --- a/docs/api/enums/modules_assets.AssetHistoryEventType.md +++ b/docs/api/enums/modules_assets.AssetHistoryEventType.md @@ -4,7 +4,7 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [ASSET\_CREATED](modules_assets.AssetHistoryEventType.md#asset_created) - [ASSET\_OFFERED](modules_assets.AssetHistoryEventType.md#asset_offered) @@ -12,32 +12,32 @@ - [ASSET\_OFFER\_REJECTED](modules_assets.AssetHistoryEventType.md#asset_offer_rejected) - [ASSET\_TRANSFERRED](modules_assets.AssetHistoryEventType.md#asset_transferred) -## Enumeration members +## Enumeration Members ### ASSET\_CREATED -• **ASSET\_CREATED** = `"ASSET_CREATED"` +• **ASSET\_CREATED** = ``"ASSET_CREATED"`` ___ ### ASSET\_OFFERED -• **ASSET\_OFFERED** = `"ASSET_OFFERED"` +• **ASSET\_OFFERED** = ``"ASSET_OFFERED"`` ___ ### ASSET\_OFFER\_CANCELED -• **ASSET\_OFFER\_CANCELED** = `"ASSET_OFFER_CANCELED"` +• **ASSET\_OFFER\_CANCELED** = ``"ASSET_OFFER_CANCELED"`` ___ ### ASSET\_OFFER\_REJECTED -• **ASSET\_OFFER\_REJECTED** = `"ASSET_OFFER_REJECTED"` +• **ASSET\_OFFER\_REJECTED** = ``"ASSET_OFFER_REJECTED"`` ___ ### ASSET\_TRANSFERRED -• **ASSET\_TRANSFERRED** = `"ASSET_TRANSFERRED"` +• **ASSET\_TRANSFERRED** = ``"ASSET_TRANSFERRED"`` diff --git a/docs/api/enums/modules_cache_client.Order.md b/docs/api/enums/modules_cache_client.Order.md index 9a4eca59..467a1d4d 100644 --- a/docs/api/enums/modules_cache_client.Order.md +++ b/docs/api/enums/modules_cache_client.Order.md @@ -4,19 +4,19 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [ASC](modules_cache_client.Order.md#asc) - [DESC](modules_cache_client.Order.md#desc) -## Enumeration members +## Enumeration Members ### ASC -• **ASC** = `"ASC"` +• **ASC** = ``"ASC"`` ___ ### DESC -• **DESC** = `"DESC"` +• **DESC** = ``"DESC"`` diff --git a/docs/api/enums/modules_cache_client.SearchType.md b/docs/api/enums/modules_cache_client.SearchType.md index 316b4d92..66839f7d 100644 --- a/docs/api/enums/modules_cache_client.SearchType.md +++ b/docs/api/enums/modules_cache_client.SearchType.md @@ -4,26 +4,26 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [App](modules_cache_client.SearchType.md#app) - [Org](modules_cache_client.SearchType.md#org) - [Role](modules_cache_client.SearchType.md#role) -## Enumeration members +## Enumeration Members ### App -• **App** = `"App"` +• **App** = ``"App"`` ___ ### Org -• **Org** = `"Org"` +• **Org** = ``"Org"`` ___ ### Role -• **Role** = `"Role"` +• **Role** = ``"Role"`` diff --git a/docs/api/enums/modules_claims.ClaimEventType.md b/docs/api/enums/modules_claims.ClaimEventType.md index 2a9bc95b..1d9bd7a7 100644 --- a/docs/api/enums/modules_claims.ClaimEventType.md +++ b/docs/api/enums/modules_claims.ClaimEventType.md @@ -4,26 +4,26 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [ISSUE\_CREDENTIAL](modules_claims.ClaimEventType.md#issue_credential) - [REJECT\_CREDENTIAL](modules_claims.ClaimEventType.md#reject_credential) - [REQUEST\_CREDENTIALS](modules_claims.ClaimEventType.md#request_credentials) -## Enumeration members +## Enumeration Members ### ISSUE\_CREDENTIAL -• **ISSUE\_CREDENTIAL** = `"issue-credential"` +• **ISSUE\_CREDENTIAL** = ``"issue-credential"`` ___ ### REJECT\_CREDENTIAL -• **REJECT\_CREDENTIAL** = `"reject-credential"` +• **REJECT\_CREDENTIAL** = ``"reject-credential"`` ___ ### REQUEST\_CREDENTIALS -• **REQUEST\_CREDENTIALS** = `"request-credential"` +• **REQUEST\_CREDENTIALS** = ``"request-credential"`` diff --git a/docs/api/enums/modules_claims.RegistrationTypes.md b/docs/api/enums/modules_claims.RegistrationTypes.md index 68369260..c69d380e 100644 --- a/docs/api/enums/modules_claims.RegistrationTypes.md +++ b/docs/api/enums/modules_claims.RegistrationTypes.md @@ -4,19 +4,19 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [OffChain](modules_claims.RegistrationTypes.md#offchain) - [OnChain](modules_claims.RegistrationTypes.md#onchain) -## Enumeration members +## Enumeration Members ### OffChain -• **OffChain** = `"RegistrationTypes::OffChain"` +• **OffChain** = ``"RegistrationTypes::OffChain"`` ___ ### OnChain -• **OnChain** = `"RegistrationTypes::OnChain"` +• **OnChain** = ``"RegistrationTypes::OnChain"`` diff --git a/docs/api/enums/modules_domains.NamespaceType.md b/docs/api/enums/modules_domains.NamespaceType.md index 10ac9243..7f090c12 100644 --- a/docs/api/enums/modules_domains.NamespaceType.md +++ b/docs/api/enums/modules_domains.NamespaceType.md @@ -4,26 +4,26 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [Application](modules_domains.NamespaceType.md#application) - [Organization](modules_domains.NamespaceType.md#organization) - [Role](modules_domains.NamespaceType.md#role) -## Enumeration members +## Enumeration Members ### Application -• **Application** = `"apps"` +• **Application** = ``"apps"`` ___ ### Organization -• **Organization** = `"org"` +• **Organization** = ``"org"`` ___ ### Role -• **Role** = `"roles"` +• **Role** = ``"roles"`` diff --git a/docs/api/enums/modules_messaging.MessagingMethod.md b/docs/api/enums/modules_messaging.MessagingMethod.md index debea7bb..752d6397 100644 --- a/docs/api/enums/modules_messaging.MessagingMethod.md +++ b/docs/api/enums/modules_messaging.MessagingMethod.md @@ -4,12 +4,12 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [Nats](modules_messaging.MessagingMethod.md#nats) -## Enumeration members +## Enumeration Members ### Nats -• **Nats** = `"nats"` +• **Nats** = ``"nats"`` diff --git a/docs/api/enums/modules_signer.ProviderEvent.md b/docs/api/enums/modules_signer.ProviderEvent.md index 33236f16..8579b2b4 100644 --- a/docs/api/enums/modules_signer.ProviderEvent.md +++ b/docs/api/enums/modules_signer.ProviderEvent.md @@ -4,18 +4,18 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [AccountChanged](modules_signer.ProviderEvent.md#accountchanged) - [Disconnected](modules_signer.ProviderEvent.md#disconnected) - [NetworkChanged](modules_signer.ProviderEvent.md#networkchanged) - [SessionUpdate](modules_signer.ProviderEvent.md#sessionupdate) -## Enumeration members +## Enumeration Members ### AccountChanged -• **AccountChanged** = `"accountsChanged"` +• **AccountChanged** = ``"accountsChanged"`` Metamask events https://docs.metamask.io/guide/ethereum-provider.html#events @@ -23,7 +23,7 @@ ___ ### Disconnected -• **Disconnected** = `"disconnect"` +• **Disconnected** = ``"disconnect"`` WalletConnect events https://docs.walletconnect.com/1.0/client-api#register-event-subscription @@ -31,10 +31,10 @@ ___ ### NetworkChanged -• **NetworkChanged** = `"networkChanged"` +• **NetworkChanged** = ``"networkChanged"`` ___ ### SessionUpdate -• **SessionUpdate** = `"session_update"` +• **SessionUpdate** = ``"session_update"`` diff --git a/docs/api/enums/modules_signer.ProviderType.md b/docs/api/enums/modules_signer.ProviderType.md index 97e7d1f5..559bb418 100644 --- a/docs/api/enums/modules_signer.ProviderType.md +++ b/docs/api/enums/modules_signer.ProviderType.md @@ -4,7 +4,7 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [EKC](modules_signer.ProviderType.md#ekc) - [EwKeyManager](modules_signer.ProviderType.md#ewkeymanager) @@ -13,38 +13,38 @@ - [PrivateKey](modules_signer.ProviderType.md#privatekey) - [WalletConnect](modules_signer.ProviderType.md#walletconnect) -## Enumeration members +## Enumeration Members ### EKC -• **EKC** = `"Enterprise Key Connect"` +• **EKC** = ``"Enterprise Key Connect"`` ___ ### EwKeyManager -• **EwKeyManager** = `"EwKeyManager"` +• **EwKeyManager** = ``"EwKeyManager"`` ___ ### Gnosis -• **Gnosis** = `"Gnosis"` +• **Gnosis** = ``"Gnosis"`` ___ ### MetaMask -• **MetaMask** = `"MetaMask"` +• **MetaMask** = ``"MetaMask"`` ___ ### PrivateKey -• **PrivateKey** = `"PrivateKey"` +• **PrivateKey** = ``"PrivateKey"`` ___ ### WalletConnect -• **WalletConnect** = `"WalletConnect"` +• **WalletConnect** = ``"WalletConnect"`` diff --git a/docs/api/enums/modules_staking.StakeStatus.md b/docs/api/enums/modules_staking.StakeStatus.md index 2221df5f..0465b8c9 100644 --- a/docs/api/enums/modules_staking.StakeStatus.md +++ b/docs/api/enums/modules_staking.StakeStatus.md @@ -4,26 +4,26 @@ ## Table of contents -### Enumeration members +### Enumeration Members - [NONSTAKING](modules_staking.StakeStatus.md#nonstaking) - [STAKING](modules_staking.StakeStatus.md#staking) - [WITHDRAWING](modules_staking.StakeStatus.md#withdrawing) -## Enumeration members +## Enumeration Members ### NONSTAKING -• **NONSTAKING** = `0` +• **NONSTAKING** = ``0`` ___ ### STAKING -• **STAKING** = `1` +• **STAKING** = ``1`` ___ ### WITHDRAWING -• **WITHDRAWING** = `2` +• **WITHDRAWING** = ``2`` diff --git a/docs/api/interfaces/modules_cache_client.ICacheClient.md b/docs/api/interfaces/modules_cache_client.ICacheClient.md index 472ee542..858dad95 100644 --- a/docs/api/interfaces/modules_cache_client.ICacheClient.md +++ b/docs/api/interfaces/modules_cache_client.ICacheClient.md @@ -10,10 +10,6 @@ ### Properties -- [pubKeyAndIdentityToken](modules_cache_client.ICacheClient.md#pubkeyandidentitytoken) - -### Methods - - [addDIDToWatchList](modules_cache_client.ICacheClient.md#adddidtowatchlist) - [deleteClaim](modules_cache_client.ICacheClient.md#deleteclaim) - [getAppDefinition](modules_cache_client.ICacheClient.md#getappdefinition) @@ -46,28 +42,27 @@ - [isAuthEnabled](modules_cache_client.ICacheClient.md#isauthenabled) - [issueClaim](modules_cache_client.ICacheClient.md#issueclaim) - [login](modules_cache_client.ICacheClient.md#login) +- [pubKeyAndIdentityToken](modules_cache_client.ICacheClient.md#pubkeyandidentitytoken) - [rejectClaim](modules_cache_client.ICacheClient.md#rejectclaim) - [requestClaim](modules_cache_client.ICacheClient.md#requestclaim) ## Properties -### pubKeyAndIdentityToken - -• **pubKeyAndIdentityToken**: `undefined` \| [`IPubKeyAndIdentityToken`](modules_signer.IPubKeyAndIdentityToken.md) +### addDIDToWatchList -## Methods +• **addDIDToWatchList**: (`did`: `string`) => `Promise`<`void`\> -### addDIDToWatchList +#### Type declaration -▸ **addDIDToWatchList**(`did`): `Promise`<`void`\> +▸ (`did`): `Promise`<`void`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `did` | `string` | -#### Returns +##### Returns `Promise`<`void`\> @@ -75,15 +70,19 @@ ___ ### deleteClaim -▸ **deleteClaim**(`claimId`): `Promise`<`void`\> +• **deleteClaim**: (`claimId`: `string`) => `Promise`<`void`\> + +#### Type declaration + +▸ (`claimId`): `Promise`<`void`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `claimId` | `string` | -#### Returns +##### Returns `Promise`<`void`\> @@ -91,15 +90,19 @@ ___ ### getAppDefinition -▸ **getAppDefinition**(`namespace`): `Promise`<`IAppDefinition`\> +• **getAppDefinition**: (`namespace`: `string`) => `Promise`<`IAppDefinition`\> -#### Parameters +#### Type declaration + +▸ (`namespace`): `Promise`<`IAppDefinition`\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<`IAppDefinition`\> @@ -107,15 +110,19 @@ ___ ### getApplicationRoles -▸ **getApplicationRoles**(`namespace`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +• **getApplicationRoles**: (`namespace`: `string`) => `Promise`<[`IRole`](modules_domains.IRole.md)[]\> + +#### Type declaration -#### Parameters +▸ (`namespace`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<[`IRole`](modules_domains.IRole.md)[]\> @@ -123,15 +130,19 @@ ___ ### getApplicationsByOrganization -▸ **getApplicationsByOrganization**(`namespace`): `Promise`<[`IApp`](modules_domains.IApp.md)[]\> +• **getApplicationsByOrganization**: (`namespace`: `string`) => `Promise`<[`IApp`](modules_domains.IApp.md)[]\> + +#### Type declaration -#### Parameters +▸ (`namespace`): `Promise`<[`IApp`](modules_domains.IApp.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<[`IApp`](modules_domains.IApp.md)[]\> @@ -139,15 +150,19 @@ ___ ### getApplicationsByOwner -▸ **getApplicationsByOwner**(`owner`): `Promise`<[`IApp`](modules_domains.IApp.md)[]\> +• **getApplicationsByOwner**: (`owner`: `string`) => `Promise`<[`IApp`](modules_domains.IApp.md)[]\> + +#### Type declaration + +▸ (`owner`): `Promise`<[`IApp`](modules_domains.IApp.md)[]\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `owner` | `string` | -#### Returns +##### Returns `Promise`<[`IApp`](modules_domains.IApp.md)[]\> @@ -155,15 +170,19 @@ ___ ### getAssetById -▸ **getAssetById**(`id`): `Promise`<[`Asset`](modules_assets.Asset.md)\> +• **getAssetById**: (`id`: `string`) => `Promise`<[`Asset`](modules_assets.Asset.md)\> + +#### Type declaration + +▸ (`id`): `Promise`<[`Asset`](modules_assets.Asset.md)\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -#### Returns +##### Returns `Promise`<[`Asset`](modules_assets.Asset.md)\> @@ -171,16 +190,20 @@ ___ ### getAssetHistory -▸ **getAssetHistory**(`id`, `filter?`): `Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> +• **getAssetHistory**: (`id`: `string`, `filter?`: [`AssetsFilter`](../modules/modules_cache_client.md#assetsfilter)) => `Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> -#### Parameters +#### Type declaration + +▸ (`id`, `filter?`): `Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | | `filter?` | [`AssetsFilter`](../modules/modules_cache_client.md#assetsfilter) | -#### Returns +##### Returns `Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> @@ -188,15 +211,19 @@ ___ ### getClaimById -▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> +• **getClaimById**: (`claimId`: `string`) => `Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> + +#### Type declaration -#### Parameters +▸ (`claimId`): `Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> + +##### Parameters | Name | Type | | :------ | :------ | | `claimId` | `string` | -#### Returns +##### Returns `Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> @@ -204,16 +231,20 @@ ___ ### getClaimsByIssuer -▸ **getClaimsByIssuer**(`issuer`, `filter?`): `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 -#### Parameters +▸ (`issuer`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `issuer` | `string` | | `filter?` | [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter) | -#### Returns +##### Returns `Promise`<[`Claim`](modules_claims.Claim.md)[]\> @@ -221,16 +252,20 @@ ___ ### getClaimsByRequester -▸ **getClaimsByRequester**(`requester`, `filter?`): `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)[]\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `requester` | `string` | | `filter?` | [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter) | -#### Returns +##### Returns `Promise`<[`Claim`](modules_claims.Claim.md)[]\> @@ -238,16 +273,20 @@ ___ ### getClaimsByRevoker -▸ **getClaimsByRevoker**(`revoker`, `filter?`): `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)[]\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `revoker` | `string` | | `filter?` | [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter) | -#### Returns +##### Returns `Promise`<[`Claim`](modules_claims.Claim.md)[]\> @@ -255,16 +294,20 @@ ___ ### getClaimsBySubject -▸ **getClaimsBySubject**(`subject`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +• **getClaimsBySubject**: (`subject`: `string`, `filter?`: [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter)) => `Promise`<[`Claim`](modules_claims.Claim.md)[]\> -#### Parameters +#### Type declaration + +▸ (`subject`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `subject` | `string` | | `filter?` | [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter) | -#### Returns +##### Returns `Promise`<[`Claim`](modules_claims.Claim.md)[]\> @@ -272,15 +315,19 @@ ___ ### getClaimsBySubjects -▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> +• **getClaimsBySubjects**: (`subjects`: `string`[]) => `Promise`<[`Claim`](modules_claims.Claim.md)[]\> + +#### Type declaration -#### Parameters +▸ (`subjects`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `subjects` | `string`[] | -#### Returns +##### Returns `Promise`<[`Claim`](modules_claims.Claim.md)[]\> @@ -288,15 +335,19 @@ ___ ### getDIDsForRole -▸ **getDIDsForRole**(`namespace`): `Promise`<`string`[]\> +• **getDIDsForRole**: (`namespace`: `string`) => `Promise`<`string`[]\> + +#### Type declaration -#### Parameters +▸ (`namespace`): `Promise`<`string`[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<`string`[]\> @@ -304,16 +355,20 @@ ___ ### getDidDocument -▸ **getDidDocument**(`did`, `includeClaims?`): `Promise`<`IDIDDocument`\> +• **getDidDocument**: (`did`: `string`, `includeClaims?`: `boolean`) => `Promise`<`IDIDDocument`\> + +#### Type declaration + +▸ (`did`, `includeClaims?`): `Promise`<`IDIDDocument`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `did` | `string` | | `includeClaims?` | `boolean` | -#### Returns +##### Returns `Promise`<`IDIDDocument`\> @@ -321,16 +376,20 @@ ___ ### getNamespaceBySearchPhrase -▸ **getNamespaceBySearchPhrase**(`phrase`, `types?`): `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))[]\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `phrase` | `string` | | `types?` | [`SearchType`](../enums/modules_cache_client.SearchType.md)[] | -#### Returns +##### Returns `Promise`<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> @@ -338,15 +397,19 @@ ___ ### getOfferedAssets -▸ **getOfferedAssets**(`offeredTo`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +• **getOfferedAssets**: (`offeredTo`: `string`) => `Promise`<[`Asset`](modules_assets.Asset.md)[]\> -#### Parameters +#### Type declaration + +▸ (`offeredTo`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `offeredTo` | `string` | -#### Returns +##### Returns `Promise`<[`Asset`](modules_assets.Asset.md)[]\> @@ -354,15 +417,19 @@ ___ ### getOrgDefinition -▸ **getOrgDefinition**(`namespace`): `Promise`<`IOrganizationDefinition`\> +• **getOrgDefinition**: (`namespace`: `string`) => `Promise`<`IOrganizationDefinition`\> + +#### Type declaration -#### Parameters +▸ (`namespace`): `Promise`<`IOrganizationDefinition`\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<`IOrganizationDefinition`\> @@ -370,15 +437,19 @@ ___ ### getOrgHierarchy -▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> +• **getOrgHierarchy**: (`namespace`: `string`) => `Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> + +#### Type declaration -#### Parameters +▸ (`namespace`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> @@ -386,15 +457,19 @@ ___ ### getOrganizationRoles -▸ **getOrganizationRoles**(`namespace`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +• **getOrganizationRoles**: (`namespace`: `string`) => `Promise`<[`IRole`](modules_domains.IRole.md)[]\> + +#### Type declaration + +▸ (`namespace`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<[`IRole`](modules_domains.IRole.md)[]\> @@ -402,16 +477,20 @@ ___ ### getOrganizationsByOwner -▸ **getOrganizationsByOwner**(`owner`, `excludeSubOrgs?`): `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)[]\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `owner` | `string` | | `excludeSubOrgs?` | `boolean` | -#### Returns +##### Returns `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> @@ -419,15 +498,19 @@ ___ ### getOwnedAssets -▸ **getOwnedAssets**(`owner`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +• **getOwnedAssets**: (`owner`: `string`) => `Promise`<[`Asset`](modules_assets.Asset.md)[]\> -#### Parameters +#### Type declaration + +▸ (`owner`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `owner` | `string` | -#### Returns +##### Returns `Promise`<[`Asset`](modules_assets.Asset.md)[]\> @@ -435,15 +518,19 @@ ___ ### getPreviouslyOwnedAssets -▸ **getPreviouslyOwnedAssets**(`owner`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> +• **getPreviouslyOwnedAssets**: (`owner`: `string`) => `Promise`<[`Asset`](modules_assets.Asset.md)[]\> + +#### Type declaration -#### Parameters +▸ (`owner`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `owner` | `string` | -#### Returns +##### Returns `Promise`<[`Asset`](modules_assets.Asset.md)[]\> @@ -451,15 +538,19 @@ ___ ### getRoleDefinition -▸ **getRoleDefinition**(`namespace`): `Promise`<`IRoleDefinition`\> +• **getRoleDefinition**: (`namespace`: `string`) => `Promise`<`IRoleDefinition`\> + +#### Type declaration -#### Parameters +▸ (`namespace`): `Promise`<`IRoleDefinition`\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<`IRoleDefinition`\> @@ -467,15 +558,19 @@ ___ ### getRolesByOwner -▸ **getRolesByOwner**(`owner`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +• **getRolesByOwner**: (`owner`: `string`) => `Promise`<[`IRole`](modules_domains.IRole.md)[]\> + +#### Type declaration + +▸ (`owner`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `owner` | `string` | -#### Returns +##### Returns `Promise`<[`IRole`](modules_domains.IRole.md)[]\> @@ -483,15 +578,19 @@ ___ ### getRolesByRevoker -▸ **getRolesByRevoker**(`revoker`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> +• **getRolesByRevoker**: (`revoker`: `string`) => `Promise`<[`IRole`](modules_domains.IRole.md)[]\> + +#### Type declaration + +▸ (`revoker`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `revoker` | `string` | -#### Returns +##### Returns `Promise`<[`IRole`](modules_domains.IRole.md)[]\> @@ -499,15 +598,19 @@ ___ ### getRolesDefinition -▸ **getRolesDefinition**(`namespace`): `Promise`<`Record`<`string`, `IRoleDefinition`\>\> +• **getRolesDefinition**: (`namespace`: `string`[]) => `Promise`<`Record`<`string`, `IRoleDefinition`\>\> -#### Parameters +#### Type declaration + +▸ (`namespace`): `Promise`<`Record`<`string`, `IRoleDefinition`\>\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string`[] | -#### Returns +##### Returns `Promise`<`Record`<`string`, `IRoleDefinition`\>\> @@ -515,15 +618,19 @@ ___ ### getSubOrganizationsByOrganization -▸ **getSubOrganizationsByOrganization**(`namespace`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> +• **getSubOrganizationsByOrganization**: (`namespace`: `string`) => `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> + +#### Type declaration -#### Parameters +▸ (`namespace`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> + +##### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | -#### Returns +##### Returns `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> @@ -531,9 +638,13 @@ ___ ### isAuthEnabled -▸ **isAuthEnabled**(): `boolean` +• **isAuthEnabled**: () => `boolean` + +#### Type declaration -#### Returns +▸ (): `boolean` + +##### Returns `boolean` @@ -541,16 +652,20 @@ ___ ### issueClaim -▸ **issueClaim**(`issuer`, `message`): `Promise`<`void`\> +• **issueClaim**: (`issuer`: `string`, `message`: [`IClaimIssuance`](modules_claims.IClaimIssuance.md)) => `Promise`<`void`\> + +#### Type declaration + +▸ (`issuer`, `message`): `Promise`<`void`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `issuer` | `string` | | `message` | [`IClaimIssuance`](modules_claims.IClaimIssuance.md) | -#### Returns +##### Returns `Promise`<`void`\> @@ -558,26 +673,40 @@ ___ ### login -▸ **login**(): `Promise`<`void`\> +• **login**: () => `Promise`<`void`\> + +#### Type declaration + +▸ (): `Promise`<`void`\> -#### Returns +##### Returns `Promise`<`void`\> ___ +### pubKeyAndIdentityToken + +• **pubKeyAndIdentityToken**: `undefined` \| [`IPubKeyAndIdentityToken`](modules_signer.IPubKeyAndIdentityToken.md) + +___ + ### rejectClaim -▸ **rejectClaim**(`issuer`, `message`): `Promise`<`void`\> +• **rejectClaim**: (`issuer`: `string`, `message`: [`IClaimRejection`](modules_claims.IClaimRejection.md)) => `Promise`<`void`\> + +#### Type declaration + +▸ (`issuer`, `message`): `Promise`<`void`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `issuer` | `string` | | `message` | [`IClaimRejection`](modules_claims.IClaimRejection.md) | -#### Returns +##### Returns `Promise`<`void`\> @@ -585,14 +714,18 @@ ___ ### requestClaim -▸ **requestClaim**(`message`): `Promise`<`void`\> +• **requestClaim**: (`message`: [`IClaimRequest`](modules_claims.IClaimRequest.md)) => `Promise`<`void`\> + +#### Type declaration + +▸ (`message`): `Promise`<`void`\> -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `message` | [`IClaimRequest`](modules_claims.IClaimRequest.md) | -#### Returns +##### Returns `Promise`<`void`\> diff --git a/docs/api/interfaces/modules_claims.PublishPublicClaimOptions.md b/docs/api/interfaces/modules_claims.PublishPublicClaimOptions.md index 45c50927..a9205b86 100644 --- a/docs/api/interfaces/modules_claims.PublishPublicClaimOptions.md +++ b/docs/api/interfaces/modules_claims.PublishPublicClaimOptions.md @@ -39,4 +39,4 @@ ___ • `Optional` **token**: `string` -**`deprecated`** +**`Deprecated`** diff --git a/docs/api/interfaces/modules_claims.RegisterOnchainOptions.md b/docs/api/interfaces/modules_claims.RegisterOnchainOptions.md index abb48bff..41433758 100644 --- a/docs/api/interfaces/modules_claims.RegisterOnchainOptions.md +++ b/docs/api/interfaces/modules_claims.RegisterOnchainOptions.md @@ -77,4 +77,4 @@ ___ • `Optional` **token**: `string` -**`deprecated`** +**`Deprecated`** diff --git a/docs/api/interfaces/modules_domains.ReturnStep.md b/docs/api/interfaces/modules_domains.ReturnStep.md index 3cfa0249..07a517ed 100644 --- a/docs/api/interfaces/modules_domains.ReturnStep.md +++ b/docs/api/interfaces/modules_domains.ReturnStep.md @@ -7,11 +7,8 @@ ### Properties - [info](modules_domains.ReturnStep.md#info) -- [tx](modules_domains.ReturnStep.md#tx) - -### Methods - - [next](modules_domains.ReturnStep.md#next) +- [tx](modules_domains.ReturnStep.md#tx) ## Properties @@ -21,16 +18,20 @@ ___ -### tx +### next -• **tx**: `EncodedCall` +• **next**: () => `Promise`<`void`\> -## Methods +#### Type declaration -### next +▸ (): `Promise`<`void`\> -▸ **next**(): `Promise`<`void`\> - -#### Returns +##### Returns `Promise`<`void`\> + +___ + +### tx + +• **tx**: `EncodedCall` diff --git a/docs/api/interfaces/modules_domains.ReturnStepWithRetryCheck.md b/docs/api/interfaces/modules_domains.ReturnStepWithRetryCheck.md index 7d66016c..94e95a6e 100644 --- a/docs/api/interfaces/modules_domains.ReturnStepWithRetryCheck.md +++ b/docs/api/interfaces/modules_domains.ReturnStepWithRetryCheck.md @@ -7,11 +7,8 @@ ### Properties - [info](modules_domains.ReturnStepWithRetryCheck.md#info) -- [tx](modules_domains.ReturnStepWithRetryCheck.md#tx) - -### Methods - - [next](modules_domains.ReturnStepWithRetryCheck.md#next) +- [tx](modules_domains.ReturnStepWithRetryCheck.md#tx) ## Properties @@ -21,23 +18,27 @@ ___ -### tx +### next -• **tx**: `EncodedCall` +• **next**: (`opt?`: { `retryCheck?`: `boolean` }) => `Promise`<`undefined` \| `TransactionReceipt`\> -## Methods +#### Type declaration -### next +▸ (`opt?`): `Promise`<`undefined` \| `TransactionReceipt`\> -▸ **next**(`opt?`): `Promise`<`undefined` \| `TransactionReceipt`\> - -#### Parameters +##### Parameters | Name | Type | | :------ | :------ | | `opt?` | `Object` | | `opt.retryCheck?` | `boolean` | -#### Returns +##### Returns `Promise`<`undefined` \| `TransactionReceipt`\> + +___ + +### tx + +• **tx**: `EncodedCall` diff --git a/docs/api/modules/modules_cache_client.md b/docs/api/modules/modules_cache_client.md index 61005b74..e2ac84e4 100644 --- a/docs/api/modules/modules_cache_client.md +++ b/docs/api/modules/modules_cache_client.md @@ -17,7 +17,7 @@ - [CacheServerClientOptions](../interfaces/modules_cache_client.CacheServerClientOptions.md) - [ICacheClient](../interfaces/modules_cache_client.ICacheClient.md) -### Type aliases +### Type Aliases - [AssetsFilter](modules_cache_client.md#assetsfilter) - [ClaimsFilter](modules_cache_client.md#claimsfilter) @@ -26,7 +26,7 @@ - [TEST\_LOGIN\_ENDPOINT](modules_cache_client.md#test_login_endpoint) -## Type aliases +## Type Aliases ### AssetsFilter diff --git a/docs/api/modules/modules_claims.md b/docs/api/modules/modules_claims.md index a99f7ccd..7ec5fbfd 100644 --- a/docs/api/modules/modules_claims.md +++ b/docs/api/modules/modules_claims.md @@ -42,7 +42,7 @@ - [RevokeMultipleClaimOptions](../interfaces/modules_claims.RevokeMultipleClaimOptions.md) - [VerifyEnrolmentPrerequisitesOptions](../interfaces/modules_claims.VerifyEnrolmentPrerequisitesOptions.md) -### Type aliases +### Type Aliases - [IssueClaim](modules_claims.md#issueclaim) - [RejectClaim](modules_claims.md#rejectclaim) @@ -60,7 +60,7 @@ - [readyToBeRegisteredOnchain](modules_claims.md#readytoberegisteredonchain) -## Type aliases +## Type Aliases ### IssueClaim diff --git a/docs/api/modules/modules_domains.md b/docs/api/modules/modules_domains.md index 8a4a8785..13dffe62 100644 --- a/docs/api/modules/modules_domains.md +++ b/docs/api/modules/modules_domains.md @@ -35,7 +35,7 @@ - [SetRoleDefinitionOptions](../interfaces/modules_domains.SetRoleDefinitionOptions.md) - [ValidateOwnershipOptions](../interfaces/modules_domains.ValidateOwnershipOptions.md) -### Type aliases +### Type Aliases - [DomainDefinition](modules_domains.md#domaindefinition) - [MulticallTx](modules_domains.md#multicalltx) @@ -48,7 +48,7 @@ - [castToV2](modules_domains.md#casttov2) -## Type aliases +## Type Aliases ### DomainDefinition @@ -58,7 +58,7 @@ ___ ### MulticallTx -Ƭ **MulticallTx**: { `info`: `string` ; `tx`: `EncodedCall` ; `next`: (`opts?`: { `retryCheck?`: `boolean` }) => `Promise`<`undefined` \| `TransactionReceipt`\> }[] +Ƭ **MulticallTx**: { `info`: `string` ; `next`: (`opts?`: { `retryCheck?`: `boolean` }) => `Promise`<`providers.TransactionReceipt` \| `undefined`\> ; `tx`: `EncodedCall` }[] ## Variables diff --git a/docs/api/modules/modules_messaging.md b/docs/api/modules/modules_messaging.md index cbf96e42..37f0090e 100644 --- a/docs/api/modules/modules_messaging.md +++ b/docs/api/modules/modules_messaging.md @@ -15,11 +15,11 @@ - [IMessage](../interfaces/modules_messaging.IMessage.md) - [SubscribeToOptions](../interfaces/modules_messaging.SubscribeToOptions.md) -### Type aliases +### Type Aliases - [MessageHandler](modules_messaging.md#messagehandler) -## Type aliases +## Type Aliases ### MessageHandler diff --git a/docs/api/modules/modules_signer.md b/docs/api/modules/modules_signer.md index 120b972f..43d75f97 100644 --- a/docs/api/modules/modules_signer.md +++ b/docs/api/modules/modules_signer.md @@ -16,7 +16,7 @@ - [IPubKeyAndIdentityToken](../interfaces/modules_signer.IPubKeyAndIdentityToken.md) -### Type aliases +### Type Aliases - [AccountInfo](modules_signer.md#accountinfo) - [ServiceInitializer](modules_signer.md#serviceinitializer) @@ -37,7 +37,7 @@ - [fromWalletConnectMetamask](modules_signer.md#fromwalletconnectmetamask) - [isMetamaskExtensionPresent](modules_signer.md#ismetamaskextensionpresent) -## Type aliases +## Type Aliases ### AccountInfo @@ -106,7 +106,9 @@ ___ ▸ **fromGnosis**(`safeAppSdk`): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> -**`description`** Intended for use in Volta Gnosis web interface(https://volta.gnosis-safe.io/). +**`Description`** + +Intended for use in Volta Gnosis web interface(https://volta.gnosis-safe.io/). Dapp should provide SafeAppSdk injected by Gnosis interface #### Parameters diff --git a/docs/api/modules/modules_staking.md b/docs/api/modules/modules_staking.md index c8d3e76a..f8a23eb0 100644 --- a/docs/api/modules/modules_staking.md +++ b/docs/api/modules/modules_staking.md @@ -11,12 +11,12 @@ - [StakingFactoryService](../classes/modules_staking.StakingFactoryService.md) - [StakingPoolService](../classes/modules_staking.StakingPoolService.md) -### Type aliases +### Type Aliases - [Service](modules_staking.md#service) - [Stake](modules_staking.md#stake) -## Type aliases +## Type Aliases ### Service diff --git a/docs/api/modules/modules_verifiable_credentials.md b/docs/api/modules/modules_verifiable_credentials.md index 6649c052..8101eb24 100644 --- a/docs/api/modules/modules_verifiable_credentials.md +++ b/docs/api/modules/modules_verifiable_credentials.md @@ -19,7 +19,7 @@ - [StatusList2021UnsignedCredential](../interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md) - [VerifyVerifiableCredentialResults](../interfaces/modules_verifiable_credentials.VerifyVerifiableCredentialResults.md) -### Type aliases +### Type Aliases - [StatusList2021Credential](modules_verifiable_credentials.md#statuslist2021credential) @@ -35,7 +35,7 @@ - [getVerifiableCredentialsService](modules_verifiable_credentials.md#getverifiablecredentialsservice) - [isRoleCredential](modules_verifiable_credentials.md#isrolecredential) -## Type aliases +## Type Aliases ### StatusList2021Credential diff --git a/e2e/claims.service.e2e.ts b/e2e/claims.service.e2e.ts index e7eafbef..0cec0c15 100644 --- a/e2e/claims.service.e2e.ts +++ b/e2e/claims.service.e2e.ts @@ -103,12 +103,10 @@ const roles: Record = { [`${resolveVC}.${root}`]: { ...baseRoleDef, roleName: resolveVC, - issuer: { issuerType: 'DID', did: [rootOwnerDID] }, }, [`${verifyVcRole2}.${root}`]: { ...baseRoleDef, roleName: verifyVcRole2, - issuer: { issuerType: 'DID', did: [staticIssuerDID] }, }, [`${verifyOffChainClaimRole}.${root}`]: { ...baseRoleDef, @@ -277,7 +275,7 @@ describe('Сlaim tests', () => { return allowedRoles; }); - Reflect.set(didRegistry, '_staticIssuerDIDnt', undefined); + Reflect.set(didRegistry, '_cacheClient', undefined); setLogger(new ConsoleLogger(LogLevel.warn)); const cacheClient = new CacheClient(signerService); verifiableCredentialsService = await getVerifiableCredentialsService( @@ -309,7 +307,6 @@ describe('Сlaim tests', () => { await signerService.connect(requestSigner, ProviderType.PrivateKey); const requesterDID = signerService.did; const requestorFields = [{ key: 'temperature', value: 36 }]; - //CREATE CLAIM REQUEST AND ISSUE CLAIM RESQUEST await claimsService.createClaimRequest({ claim: { claimType, @@ -815,6 +812,125 @@ describe('Сlaim tests', () => { ) ).toBeDefined(); }); + + const createExampleSignedCredential = async ( + issuerFields: IssuerFields[], + namespace: string, + expirationDate?: Date + ) => { + return await verifiableCredentialsService.createRoleVC({ + id: rootOwnerDID, + namespace: namespace, + version: '1', + issuerFields, + expirationDate, + }); + }; + + test('verifyVc should verify a credential with no errors if the Issuer is authorized', async () => { + await signerService.connect(rootOwner, ProviderType.PrivateKey); + await domainsService.createRole({ + roleName: verifyVcRole, + namespace, + data: roles[`${verifyVcRole}.${root}`], + returnSteps: false, + }); + const vc = await createExampleSignedCredential( + [], + `${verifyVcRole}.${root}` + ); + const result = await claimsService.verifyVc(vc); + expect(result.errors).toHaveLength(0); + expect(result.isVerified).toBeTruthy; + }); + test('resolveCredentialAndVerify should resolve a Verifiable Credential and call correct verification method (verifyVC)', async () => { + const roleName = `${resolveVC}.${root}`; + await signerService.connect(rootOwner, ProviderType.PrivateKey); + await domainsService.createRole({ + roleName: resolveVC, + namespace, + data: roles[roleName], + returnSteps: false, + }); + await signerService.connect(staticIssuer, ProviderType.PrivateKey); + await createExampleSignedCredential([], roleName); + const { issuedToken } = await enrolAndIssue(rootOwner, staticIssuer, { + subjectDID: rootOwnerDID, + claimType: roleName, + registrationTypes: [ + RegistrationTypes.OnChain, + RegistrationTypes.OffChain, // role type issuer should have offchain claim + ], + publishOnChain: true, + issuerFields: [], + }); + await signerService.connect(rootOwner, ProviderType.PrivateKey); + let subjectDoc = await didRegistry.getDidDocument({ + did: rootOwnerDID, + includeClaims: true, + }); + mockCachedDocument.mockResolvedValueOnce(subjectDoc); + + await claimsService.publishPublicClaim({ + claim: { token: issuedToken }, + }); + + subjectDoc = await didRegistry.getDidDocument({ + did: rootOwnerDID, + includeClaims: true, + }); + const result = await claimsService.resolveCredentialAndVerify( + rootOwnerDID, + roleName + ); + expect(result.errors).toHaveLength(0); + expect(result.isVerified).toBeTruthy; + expect(claimsService.verifyVc).toHaveBeenCalled; + }); + test('resolveAndVerify should verify an issued off chain claim', async () => { + const roleName = `${verifyOffChainClaimRole}.${root}`; + //CREATE CLAIM REQUEST AND ISSUE CLAIM RESQUEST + await domainsService.createRole({ + roleName: verifyOffChainClaimRole, + namespace, + data: roles[roleName], + returnSteps: false, + }); + + await signerService.connect(staticIssuer, ProviderType.PrivateKey); + const { issuedToken } = await enrolAndIssue(rootOwner, staticIssuer, { + subjectDID: rootOwnerDID, + claimType: roleName, + registrationTypes: [ + RegistrationTypes.OnChain, + RegistrationTypes.OffChain, // role type issuer should have offchain claim + ], + publishOnChain: true, + issuerFields: [], + }); + await signerService.connect(rootOwner, ProviderType.PrivateKey); + let subjectDoc = await didRegistry.getDidDocument({ + did: rootOwnerDID, + includeClaims: true, + }); + mockCachedDocument.mockResolvedValueOnce(subjectDoc); + + await claimsService.publishPublicClaim({ + claim: { token: issuedToken }, + }); + + subjectDoc = await didRegistry.getDidDocument({ + did: rootOwnerDID, + includeClaims: true, + }); + const result = await claimsService.resolveCredentialAndVerify( + rootOwnerDID, + roleName + ); + expect(result.errors).toHaveLength(0); + expect(result.isVerified).toBeTruthy; + expect(claimsService.verifyRoleEIP191JWT).toHaveBeenCalled; + }); }); describe('Selfsigned claim tests', () => { @@ -870,118 +986,4 @@ describe('Сlaim tests', () => { ).toBeDefined(); }); }); - - describe('Verification Tests', () => { - const createExampleSignedCredential = async ( - issuerFields: IssuerFields[], - namespace: string, - expirationDate?: Date - ) => { - return await verifiableCredentialsService.createRoleVC({ - id: rootOwnerDID, - namespace: namespace, - version: '1', - issuerFields, - expirationDate, - }); - }; - - test('verifyVc should verify a credential with no errors if the Issuer is authorized', async () => { - await signerService.connect(rootOwner, ProviderType.PrivateKey); - await domainsService.createRole({ - roleName: verifyVcRole, - namespace, - data: roles[`${verifyVcRole}.${root}`], - returnSteps: false, - }); - const vc = await createExampleSignedCredential( - [], - `${verifyVcRole}.${root}` - ); - const result = await claimsService.verifyVc(vc); - expect(result.errors).toHaveLength(0); - expect(result.isVerified).toBeTruthy; - }); - test('verifyVc should: not verify a credential and return an issuer error if the issuer is not authorized', async () => { - const roleName = `${verifyVcRole2}.${root}`; - await domainsService.createRole({ - roleName: verifyVcRole2, - namespace, - data: roles[roleName], - returnSteps: false, - }); - const vc = await createExampleSignedCredential([], roleName); - const result = await claimsService.verifyVc(vc); - expect(result.errors).toHaveLength(1); - expect(result.errors).toContain( - `Issuer ${rootOwnerDID} is not authorized to issue ${roleName}: issuer is not in DID list` - ); - expect(result.isVerified).toBeFalsy; - }); - test('resolveCredentialAndVerify should resolve a Verifiable Credential and call correct verification method (verifyVC)', async () => { - const roleName = `${resolveVC}.${root}`; - console.log(rootOwnerDID, 'CHECK THE DID'); - await signerService.connect(rootOwner, ProviderType.PrivateKey); - await domainsService.createRole({ - roleName: resolveVC, - namespace, - data: roles[roleName], - returnSteps: false, - }); - await createExampleSignedCredential([], roleName); - const result = await claimsService.resolveCredentialAndVerify( - rootOwnerDID, - roleName - ); - console.log(result, 'THE RESOLVE RESULT'); - }); - test('verifyOffChainClaim should verify an issued off chain claim', async () => { - // const roleName = `${verifyOffChainClaimRole}.${root}`; - // await signerService.connect(rootOwner, ProviderType.PrivateKey); - // const requestorFields = [{ key: 'temperature', value: 36 }]; - // //CREATE CLAIM REQUEST AND ISSUE CLAIM RESQUEST - // await domainsService.createRole({ - // roleName: verifyOffChainClaimRole, - // namespace, - // data: roles[roleName], - // returnSteps: false, - // }); - // const claimRequest = await claimsService.createClaimRequest({ - // claim: { - // claimType: roleName, - // claimTypeVersion: version, - // requestorFields, - // }, - // registrationTypes: [ - // RegistrationTypes.OffChain, - // RegistrationTypes.OnChain, - // ], - // subject: rootOwnerDID, - // }); - // console.log(claimRequest, 'THE CLAIM REQUEST'); - // const [message] = mockRequestClaim.mock.calls.pop(); - - // message.claimIssuer = [staticIssuerDID]; - // console.log(message, 'THE MESSAGE'); - // console.log(staticIssuer, 'THE STATIC ISSUER'); - // await signerService.connect(staticIssuer, ProviderType.PrivateKey); - // const issuance = await claimsService.issueClaimRequest({ - // publishOnChain: false, - // issuerFields: [], - // expirationTimestamp: undefined, - // ...message, - // }); - // console.log(issuance, 'THE ISSUANCE'); - // const [, issuedClaim] = <[string, Required]>( - // mockIssueClaim.mock.calls.pop() - // ); - // console.log(issuedClaim, 'THE ISSUED CLAIM'); - // //await signerService.connect(rootOwner, ProviderType.PrivateKey); - // const result = await claimsService.verifyOffChainClaim( - // rootOwnerDID, - // roleName - // ); - // console.log(result, 'ON CHAIN CLAIM RESULT'); - }); - }); }); diff --git a/src/modules/claims/claims.service.ts b/src/modules/claims/claims.service.ts index 0450502a..273749d4 100644 --- a/src/modules/claims/claims.service.ts +++ b/src/modules/claims/claims.service.ts @@ -1451,7 +1451,7 @@ export class ClaimsService { async verifyRoleEIP191JWT( roleEIP191JWT: RoleEIP191JWT ): Promise { - const {payload, eip191Jwt} = offChainClaim; + const { payload, eip191Jwt } = roleEIP191JWT; const errors: string[] = []; const issuerDID = this._signerService.did; const claimIssuerVerifier = new ClaimIssuerVerification( @@ -1460,16 +1460,19 @@ export class ClaimsService { this._credentialResolver, this._issuerResolver ); - const issuerVerified = await claimIssuerVerifier.verifyIssuer( - issuerDID, - payload?.claimData?.claimType - ); + const issuerVerified = await claimIssuerVerifier.verifyIssuer( + issuerDID, + payload?.claimData?.claimType + ); if (!issuerVerified) { errors.push(ERROR_MESSAGES.OFFCHAIN_ISSUER_NOT_AUTHORIZED); } - const proofVerified = await this._didRegistry.verifyPublicClaim(eip191Jwt, payload?.iss as string); + const proofVerified = await this._didRegistry.verifyPublicClaim( + eip191Jwt, + payload?.iss as string + ); if (!proofVerified) { - errors.push(ERROR_MESSAGES.PROOF_NOT_VERIFIED) + errors.push(ERROR_MESSAGES.PROOF_NOT_VERIFIED); } return { errors: errors, @@ -1500,7 +1503,7 @@ export class ClaimsService { } const credentialIsOffChain = resolvedCredential.eip191Jwt; return credentialIsOffChain - ? this.verifyOffChainClaim(resolvedCredential as RoleEIP191JWT) + ? this.verifyRoleEIP191JWT(resolvedCredential as RoleEIP191JWT) : this.verifyVc( resolvedCredential as VerifiableCredential ); diff --git a/src/modules/claims/claims.types.ts b/src/modules/claims/claims.types.ts index bd4c2025..eed63110 100644 --- a/src/modules/claims/claims.types.ts +++ b/src/modules/claims/claims.types.ts @@ -436,4 +436,4 @@ export interface CredentialVerificationResult { /** Verification errors */ errors: string[]; -} \ No newline at end of file +}