From aae1c2339bf9eaf5286a4603a8b9ef98b0e16b8f Mon Sep 17 00:00:00 2001 From: JGiter Date: Tue, 19 Apr 2022 13:38:00 +0300 Subject: [PATCH] docs: organize api by modules --- docs/api/classes/CacheClient.md | 776 ---------------- .../ChangeOwnershipNotPossibleError.md | 31 - .../DeletingNamespaceNotPossibleError.md | 31 - .../classes/ENSOwnerNotValidAddressError.md | 29 - docs/api/classes/ENSTypeNotSupportedError.md | 23 - docs/api/classes/MalformedDIDError.md | 29 - .../MethodNotAvailableInNodeEnvError.md | 29 - docs/api/classes/StakingFactoryService.md | 69 -- .../VerifiableCredentialsServiceBase.md | 117 --- ...ice.md => modules_assets.AssetsService.md} | 64 +- .../modules_cacheClient.CacheClient.md | 778 ++++++++++++++++ ...ice.md => modules_claims.ClaimsService.md} | 106 +-- ....md => modules_didRegistry.DidRegistry.md} | 64 +- ...e.md => modules_domains.DomainsService.md} | 120 +-- ... => modules_messaging.MessagingService.md} | 24 +- ...cSigner.md => modules_signer.EkcSigner.md} | 24 +- ...ice.md => modules_signer.SignerService.md} | 82 +- .../modules_staking.StakingFactoryService.md | 71 ++ ... => modules_staking.StakingPoolService.md} | 32 +- ...ntials.VerifiableCredentialsServiceBase.md | 119 +++ docs/api/enums/ERROR_MESSAGES.md | 202 ----- docs/api/enums/ExecutionEnvironment.md | 20 - docs/api/enums/SearchType.md | 27 - docs/api/enums/StakeStatus.md | 27 - ...> modules_assets.AssetHistoryEventType.md} | 12 +- ...{Order.md => modules_cacheClient.Order.md} | 6 +- .../enums/modules_cacheClient.SearchType.md | 29 + ...pe.md => modules_claims.ClaimEventType.md} | 8 +- ...md => modules_claims.RegistrationTypes.md} | 6 +- ...pe.md => modules_domains.NamespaceType.md} | 8 +- ...d => modules_messaging.MessagingMethod.md} | 4 +- ...ent.md => modules_signer.ProviderEvent.md} | 10 +- ...Type.md => modules_signer.ProviderType.md} | 14 +- docs/api/enums/modules_staking.StakeStatus.md | 29 + docs/api/interfaces/AssetHistory.md | 48 - docs/api/interfaces/AssetProfiles.md | 5 - .../interfaces/CacheServerClientOptions.md | 20 - docs/api/interfaces/ChainConfig.md | 90 -- docs/api/interfaces/Claim.md | 118 --- .../interfaces/CreatePresentationParams.md | 13 - docs/api/interfaces/IApp.md | 55 -- docs/api/interfaces/IClaimIssuance.md | 87 -- docs/api/interfaces/IClaimRejection.md | 59 -- docs/api/interfaces/IClaimRequest.md | 80 -- docs/api/interfaces/IMessage.md | 37 - docs/api/interfaces/IOrganization.md | 69 -- .../api/interfaces/IPubKeyAndIdentityToken.md | 20 - docs/api/interfaces/IssuerFields.md | 20 - docs/api/interfaces/MessagingConfig.md | 27 - docs/api/interfaces/Profile.md | 34 - docs/api/interfaces/ProofOptions.md | 20 - docs/api/interfaces/RoleCredentialSubject.md | 44 - .../interfaces/RoleCredentialSubjectParams.md | 34 - .../VerifyVerifiableCredentialResults.md | 27 - .../{Asset.md => modules_assets.Asset.md} | 14 +- .../interfaces/modules_assets.AssetHistory.md | 50 + ...es_cacheClient.CacheServerClientOptions.md | 22 + ...md => modules_cacheClient.ICacheClient.md} | 164 ++-- docs/api/interfaces/modules_claims.Claim.md | 120 +++ .../modules_claims.IClaimIssuance.md | 89 ++ .../modules_claims.IClaimRejection.md | 61 ++ .../modules_claims.IClaimRequest.md | 82 ++ ...md => modules_didRegistry.AssetProfile.md} | 6 +- .../modules_didRegistry.AssetProfiles.md | 7 + ...ta.md => modules_didRegistry.ClaimData.md} | 12 +- .../interfaces/modules_didRegistry.Profile.md | 36 + docs/api/interfaces/modules_domains.IApp.md | 57 ++ .../modules_domains.IOrganization.md | 71 ++ .../{IRole.md => modules_domains.IRole.md} | 14 +- .../interfaces/modules_messaging.IMessage.md | 39 + .../modules_signer.IPubKeyAndIdentityToken.md | 22 + ...le_credentials.CreatePresentationParams.md | 15 + ...les_verifiable_credentials.IssuerFields.md | 22 + ...les_verifiable_credentials.ProofOptions.md | 22 + ...iable_credentials.RoleCredentialSubject.md | 46 + ...credentials.RoleCredentialSubjectParams.md | 36 + ...tials.VerifyVerifiableCredentialResults.md | 29 + docs/api/modules.md | 854 +----------------- docs/api/modules/init.md | 122 +++ docs/api/modules/modules_assets.md | 16 + docs/api/modules/modules_cacheClient.md | 60 ++ docs/api/modules/modules_claims.md | 122 +++ docs/api/modules/modules_didRegistry.md | 14 + docs/api/modules/modules_domains.md | 57 ++ docs/api/modules/modules_messaging.md | 15 + docs/api/modules/modules_signer.md | 192 ++++ docs/api/modules/modules_staking.md | 46 + .../modules/modules_verifiable_credentials.md | 96 ++ docs/guides/application.md | 10 +- docs/guides/asset.md | 18 +- docs/guides/claim.md | 44 +- docs/guides/organization.md | 10 +- docs/guides/role.md | 16 +- mkdocs.yml | 28 +- typedoc.json | 16 +- 95 files changed, 3104 insertions(+), 3595 deletions(-) delete mode 100644 docs/api/classes/CacheClient.md delete mode 100644 docs/api/classes/ChangeOwnershipNotPossibleError.md delete mode 100644 docs/api/classes/DeletingNamespaceNotPossibleError.md delete mode 100644 docs/api/classes/ENSOwnerNotValidAddressError.md delete mode 100644 docs/api/classes/ENSTypeNotSupportedError.md delete mode 100644 docs/api/classes/MalformedDIDError.md delete mode 100644 docs/api/classes/MethodNotAvailableInNodeEnvError.md delete mode 100644 docs/api/classes/StakingFactoryService.md delete mode 100644 docs/api/classes/VerifiableCredentialsServiceBase.md rename docs/api/classes/{AssetsService.md => modules_assets.AssetsService.md} (62%) create mode 100644 docs/api/classes/modules_cacheClient.CacheClient.md rename docs/api/classes/{ClaimsService.md => modules_claims.ClaimsService.md} (71%) rename docs/api/classes/{DidRegistry.md => modules_didRegistry.DidRegistry.md} (70%) rename docs/api/classes/{DomainsService.md => modules_domains.DomainsService.md} (73%) rename docs/api/classes/{MessagingService.md => modules_messaging.MessagingService.md} (61%) rename docs/api/classes/{EkcSigner.md => modules_signer.EkcSigner.md} (69%) rename docs/api/classes/{SignerService.md => modules_signer.SignerService.md} (60%) create mode 100644 docs/api/classes/modules_staking.StakingFactoryService.md rename docs/api/classes/{StakingPoolService.md => modules_staking.StakingPoolService.md} (62%) create mode 100644 docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md delete mode 100644 docs/api/enums/ERROR_MESSAGES.md delete mode 100644 docs/api/enums/ExecutionEnvironment.md delete mode 100644 docs/api/enums/SearchType.md delete mode 100644 docs/api/enums/StakeStatus.md rename docs/api/enums/{AssetHistoryEventType.md => modules_assets.AssetHistoryEventType.md} (51%) rename docs/api/enums/{Order.md => modules_cacheClient.Order.md} (52%) create mode 100644 docs/api/enums/modules_cacheClient.SearchType.md rename docs/api/enums/{ClaimEventType.md => modules_claims.ClaimEventType.md} (54%) rename docs/api/enums/{RegistrationTypes.md => modules_claims.RegistrationTypes.md} (56%) rename docs/api/enums/{NamespaceType.md => modules_domains.NamespaceType.md} (50%) rename docs/api/enums/{MessagingMethod.md => modules_messaging.MessagingMethod.md} (53%) rename docs/api/enums/{ProviderEvent.md => modules_signer.ProviderEvent.md} (62%) rename docs/api/enums/{ProviderType.md => modules_signer.ProviderType.md} (52%) create mode 100644 docs/api/enums/modules_staking.StakeStatus.md delete mode 100644 docs/api/interfaces/AssetHistory.md delete mode 100644 docs/api/interfaces/AssetProfiles.md delete mode 100644 docs/api/interfaces/CacheServerClientOptions.md delete mode 100644 docs/api/interfaces/ChainConfig.md delete mode 100644 docs/api/interfaces/Claim.md delete mode 100644 docs/api/interfaces/CreatePresentationParams.md delete mode 100644 docs/api/interfaces/IApp.md delete mode 100644 docs/api/interfaces/IClaimIssuance.md delete mode 100644 docs/api/interfaces/IClaimRejection.md delete mode 100644 docs/api/interfaces/IClaimRequest.md delete mode 100644 docs/api/interfaces/IMessage.md delete mode 100644 docs/api/interfaces/IOrganization.md delete mode 100644 docs/api/interfaces/IPubKeyAndIdentityToken.md delete mode 100644 docs/api/interfaces/IssuerFields.md delete mode 100644 docs/api/interfaces/MessagingConfig.md delete mode 100644 docs/api/interfaces/Profile.md delete mode 100644 docs/api/interfaces/ProofOptions.md delete mode 100644 docs/api/interfaces/RoleCredentialSubject.md delete mode 100644 docs/api/interfaces/RoleCredentialSubjectParams.md delete mode 100644 docs/api/interfaces/VerifyVerifiableCredentialResults.md rename docs/api/interfaces/{Asset.md => modules_assets.Asset.md} (52%) create mode 100644 docs/api/interfaces/modules_assets.AssetHistory.md create mode 100644 docs/api/interfaces/modules_cacheClient.CacheServerClientOptions.md rename docs/api/interfaces/{ICacheClient.md => modules_cacheClient.ICacheClient.md} (50%) create mode 100644 docs/api/interfaces/modules_claims.Claim.md create mode 100644 docs/api/interfaces/modules_claims.IClaimIssuance.md create mode 100644 docs/api/interfaces/modules_claims.IClaimRejection.md create mode 100644 docs/api/interfaces/modules_claims.IClaimRequest.md rename docs/api/interfaces/{AssetProfile.md => modules_didRegistry.AssetProfile.md} (50%) create mode 100644 docs/api/interfaces/modules_didRegistry.AssetProfiles.md rename docs/api/interfaces/{ClaimData.md => modules_didRegistry.ClaimData.md} (51%) create mode 100644 docs/api/interfaces/modules_didRegistry.Profile.md create mode 100644 docs/api/interfaces/modules_domains.IApp.md create mode 100644 docs/api/interfaces/modules_domains.IOrganization.md rename docs/api/interfaces/{IRole.md => modules_domains.IRole.md} (51%) create mode 100644 docs/api/interfaces/modules_messaging.IMessage.md create mode 100644 docs/api/interfaces/modules_signer.IPubKeyAndIdentityToken.md create mode 100644 docs/api/interfaces/modules_verifiable_credentials.CreatePresentationParams.md create mode 100644 docs/api/interfaces/modules_verifiable_credentials.IssuerFields.md create mode 100644 docs/api/interfaces/modules_verifiable_credentials.ProofOptions.md create mode 100644 docs/api/interfaces/modules_verifiable_credentials.RoleCredentialSubject.md create mode 100644 docs/api/interfaces/modules_verifiable_credentials.RoleCredentialSubjectParams.md create mode 100644 docs/api/interfaces/modules_verifiable_credentials.VerifyVerifiableCredentialResults.md create mode 100644 docs/api/modules/init.md create mode 100644 docs/api/modules/modules_assets.md create mode 100644 docs/api/modules/modules_cacheClient.md create mode 100644 docs/api/modules/modules_claims.md create mode 100644 docs/api/modules/modules_didRegistry.md create mode 100644 docs/api/modules/modules_domains.md create mode 100644 docs/api/modules/modules_messaging.md create mode 100644 docs/api/modules/modules_signer.md create mode 100644 docs/api/modules/modules_staking.md create mode 100644 docs/api/modules/modules_verifiable_credentials.md diff --git a/docs/api/classes/CacheClient.md b/docs/api/classes/CacheClient.md deleted file mode 100644 index ded4a860..00000000 --- a/docs/api/classes/CacheClient.md +++ /dev/null @@ -1,776 +0,0 @@ -# Class: CacheClient - -## Implements - -- [`ICacheClient`](../interfaces/ICacheClient.md) - -## Table of contents - -### Constructors - -- [constructor](CacheClient.md#constructor) - -### Properties - -- [pubKeyAndIdentityToken](CacheClient.md#pubkeyandidentitytoken) - -### Methods - -- [addDIDToWatchList](CacheClient.md#adddidtowatchlist) -- [authenticate](CacheClient.md#authenticate) -- [deleteClaim](CacheClient.md#deleteclaim) -- [getAllowedRolesByIssuer](CacheClient.md#getallowedrolesbyissuer) -- [getAppDefinition](CacheClient.md#getappdefinition) -- [getApplicationRoles](CacheClient.md#getapplicationroles) -- [getApplicationsByOrganization](CacheClient.md#getapplicationsbyorganization) -- [getApplicationsByOwner](CacheClient.md#getapplicationsbyowner) -- [getAssetById](CacheClient.md#getassetbyid) -- [getAssetHistory](CacheClient.md#getassethistory) -- [getClaimById](CacheClient.md#getclaimbyid) -- [getClaimsByIssuer](CacheClient.md#getclaimsbyissuer) -- [getClaimsByRequester](CacheClient.md#getclaimsbyrequester) -- [getClaimsBySubject](CacheClient.md#getclaimsbysubject) -- [getClaimsBySubjects](CacheClient.md#getclaimsbysubjects) -- [getDIDsForRole](CacheClient.md#getdidsforrole) -- [getDidDocument](CacheClient.md#getdiddocument) -- [getNamespaceBySearchPhrase](CacheClient.md#getnamespacebysearchphrase) -- [getOfferedAssets](CacheClient.md#getofferedassets) -- [getOrgDefinition](CacheClient.md#getorgdefinition) -- [getOrgHierarchy](CacheClient.md#getorghierarchy) -- [getOrganizationRoles](CacheClient.md#getorganizationroles) -- [getOrganizationsByOwner](CacheClient.md#getorganizationsbyowner) -- [getOwnedAssets](CacheClient.md#getownedassets) -- [getPreviouslyOwnedAssets](CacheClient.md#getpreviouslyownedassets) -- [getRoleDefinition](CacheClient.md#getroledefinition) -- [getRolesByOwner](CacheClient.md#getrolesbyowner) -- [getRolesDefinition](CacheClient.md#getrolesdefinition) -- [getSubOrganizationsByOrganization](CacheClient.md#getsuborganizationsbyorganization) -- [handleError](CacheClient.md#handleerror) -- [init](CacheClient.md#init) -- [isAuthEnabled](CacheClient.md#isauthenabled) -- [issueClaim](CacheClient.md#issueclaim) -- [login](CacheClient.md#login) -- [rejectClaim](CacheClient.md#rejectclaim) -- [requestClaim](CacheClient.md#requestclaim) - -## Constructors - -### constructor - -• **new CacheClient**(`_signerService`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_signerService` | [`SignerService`](SignerService.md) | - -## Properties - -### pubKeyAndIdentityToken - -• **pubKeyAndIdentityToken**: `undefined` \| [`IPubKeyAndIdentityToken`](../interfaces/IPubKeyAndIdentityToken.md) - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[pubKeyAndIdentityToken](../interfaces/ICacheClient.md#pubkeyandidentitytoken) - -## Methods - -### addDIDToWatchList - -▸ **addDIDToWatchList**(`did`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[addDIDToWatchList](../interfaces/ICacheClient.md#adddidtowatchlist) - -___ - -### authenticate - -▸ **authenticate**(): `Promise`<`void`\> - -**`description`** Refreshes access token. If login still fails then signs new identity token and requests access token -After authentication runs previously failed requests - -#### Returns - -`Promise`<`void`\> - -___ - -### deleteClaim - -▸ **deleteClaim**(`id`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[deleteClaim](../interfaces/ICacheClient.md#deleteclaim) - -___ - -### getAllowedRolesByIssuer - -▸ **getAllowedRolesByIssuer**(`did`): `Promise`<[`IRole`](../interfaces/IRole.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`IRole`](../interfaces/IRole.md)[]\> - -___ - -### getAppDefinition - -▸ **getAppDefinition**(`namespace`): `Promise`<`IAppDefinition`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<`IAppDefinition`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getAppDefinition](../interfaces/ICacheClient.md#getappdefinition) - -___ - -### getApplicationRoles - -▸ **getApplicationRoles**(`namespace`): `Promise`<[`IRole`](../interfaces/IRole.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<[`IRole`](../interfaces/IRole.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getApplicationRoles](../interfaces/ICacheClient.md#getapplicationroles) - -___ - -### getApplicationsByOrganization - -▸ **getApplicationsByOrganization**(`namespace`): `Promise`<[`IApp`](../interfaces/IApp.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<[`IApp`](../interfaces/IApp.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getApplicationsByOrganization](../interfaces/ICacheClient.md#getapplicationsbyorganization) - -___ - -### getApplicationsByOwner - -▸ **getApplicationsByOwner**(`owner`, `withRelations?`): `Promise`<[`IApp`](../interfaces/IApp.md)[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `owner` | `string` | `undefined` | -| `withRelations` | `boolean` | `true` | - -#### Returns - -`Promise`<[`IApp`](../interfaces/IApp.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getApplicationsByOwner](../interfaces/ICacheClient.md#getapplicationsbyowner) - -___ - -### getAssetById - -▸ **getAssetById**(`id`): `Promise`<[`Asset`](../interfaces/Asset.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Promise`<[`Asset`](../interfaces/Asset.md)\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getAssetById](../interfaces/ICacheClient.md#getassetbyid) - -___ - -### getAssetHistory - -▸ **getAssetHistory**(`id`, `__namedParameters?`): `Promise`<[`AssetHistory`](../interfaces/AssetHistory.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `__namedParameters` | [`AssetsFilter`](../modules.md#assetsfilter) | - -#### Returns - -`Promise`<[`AssetHistory`](../interfaces/AssetHistory.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getAssetHistory](../interfaces/ICacheClient.md#getassethistory) - -___ - -### getClaimById - -▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](../interfaces/Claim.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `claimId` | `string` | - -#### Returns - -`Promise`<`undefined` \| [`Claim`](../interfaces/Claim.md)\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getClaimById](../interfaces/ICacheClient.md#getclaimbyid) - -___ - -### getClaimsByIssuer - -▸ **getClaimsByIssuer**(`issuer`, `__namedParameters?`): `Promise`<[`Claim`](../interfaces/Claim.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `issuer` | `string` | -| `__namedParameters` | [`ClaimsFilter`](../modules.md#claimsfilter) | - -#### Returns - -`Promise`<[`Claim`](../interfaces/Claim.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getClaimsByIssuer](../interfaces/ICacheClient.md#getclaimsbyissuer) - -___ - -### getClaimsByRequester - -▸ **getClaimsByRequester**(`requester`, `__namedParameters?`): `Promise`<[`Claim`](../interfaces/Claim.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `requester` | `string` | -| `__namedParameters` | [`ClaimsFilter`](../modules.md#claimsfilter) | - -#### Returns - -`Promise`<[`Claim`](../interfaces/Claim.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getClaimsByRequester](../interfaces/ICacheClient.md#getclaimsbyrequester) - -___ - -### getClaimsBySubject - -▸ **getClaimsBySubject**(`subject`, `__namedParameters?`): `Promise`<[`Claim`](../interfaces/Claim.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `subject` | `string` | -| `__namedParameters` | [`ClaimsFilter`](../modules.md#claimsfilter) | - -#### Returns - -`Promise`<[`Claim`](../interfaces/Claim.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getClaimsBySubject](../interfaces/ICacheClient.md#getclaimsbysubject) - -___ - -### getClaimsBySubjects - -▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](../interfaces/Claim.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `subjects` | `string`[] | - -#### Returns - -`Promise`<[`Claim`](../interfaces/Claim.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getClaimsBySubjects](../interfaces/ICacheClient.md#getclaimsbysubjects) - -___ - -### getDIDsForRole - -▸ **getDIDsForRole**(`namespace`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getDIDsForRole](../interfaces/ICacheClient.md#getdidsforrole) - -___ - -### getDidDocument - -▸ **getDidDocument**(`did`, `includeClaims?`): `Promise`<`IDIDDocument`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | -| `includeClaims?` | `boolean` | - -#### Returns - -`Promise`<`IDIDDocument`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getDidDocument](../interfaces/ICacheClient.md#getdiddocument) - -___ - -### getNamespaceBySearchPhrase - -▸ **getNamespaceBySearchPhrase**(`search`, `types?`): `Promise`<([`IRole`](../interfaces/IRole.md) \| [`IOrganization`](../interfaces/IOrganization.md) \| [`IApp`](../interfaces/IApp.md))[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `search` | `string` | -| `types?` | [`SearchType`](../enums/SearchType.md)[] | - -#### Returns - -`Promise`<([`IRole`](../interfaces/IRole.md) \| [`IOrganization`](../interfaces/IOrganization.md) \| [`IApp`](../interfaces/IApp.md))[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getNamespaceBySearchPhrase](../interfaces/ICacheClient.md#getnamespacebysearchphrase) - -___ - -### getOfferedAssets - -▸ **getOfferedAssets**(`did`): `Promise`<[`Asset`](../interfaces/Asset.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`Asset`](../interfaces/Asset.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getOfferedAssets](../interfaces/ICacheClient.md#getofferedassets) - -___ - -### getOrgDefinition - -▸ **getOrgDefinition**(`namespace`): `Promise`<`IOrganizationDefinition`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<`IOrganizationDefinition`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getOrgDefinition](../interfaces/ICacheClient.md#getorgdefinition) - -___ - -### getOrgHierarchy - -▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](../interfaces/IOrganization.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<[`IOrganization`](../interfaces/IOrganization.md)\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getOrgHierarchy](../interfaces/ICacheClient.md#getorghierarchy) - -___ - -### getOrganizationRoles - -▸ **getOrganizationRoles**(`namespace`): `Promise`<[`IRole`](../interfaces/IRole.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<[`IRole`](../interfaces/IRole.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getOrganizationRoles](../interfaces/ICacheClient.md#getorganizationroles) - -___ - -### getOrganizationsByOwner - -▸ **getOrganizationsByOwner**(`owner`, `withRelations?`): `Promise`<[`IOrganization`](../interfaces/IOrganization.md)[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `owner` | `string` | `undefined` | -| `withRelations` | `boolean` | `true` | - -#### Returns - -`Promise`<[`IOrganization`](../interfaces/IOrganization.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getOrganizationsByOwner](../interfaces/ICacheClient.md#getorganizationsbyowner) - -___ - -### getOwnedAssets - -▸ **getOwnedAssets**(`did`): `Promise`<[`Asset`](../interfaces/Asset.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`Promise`<[`Asset`](../interfaces/Asset.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getOwnedAssets](../interfaces/ICacheClient.md#getownedassets) - -___ - -### getPreviouslyOwnedAssets - -▸ **getPreviouslyOwnedAssets**(`owner`): `Promise`<[`Asset`](../interfaces/Asset.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | `string` | - -#### Returns - -`Promise`<[`Asset`](../interfaces/Asset.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getPreviouslyOwnedAssets](../interfaces/ICacheClient.md#getpreviouslyownedassets) - -___ - -### getRoleDefinition - -▸ **getRoleDefinition**(`namespace`): `Promise`<`IRoleDefinition`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<`IRoleDefinition`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getRoleDefinition](../interfaces/ICacheClient.md#getroledefinition) - -___ - -### getRolesByOwner - -▸ **getRolesByOwner**(`owner`): `Promise`<[`IRole`](../interfaces/IRole.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | `string` | - -#### Returns - -`Promise`<[`IRole`](../interfaces/IRole.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getRolesByOwner](../interfaces/ICacheClient.md#getrolesbyowner) - -___ - -### getRolesDefinition - -▸ **getRolesDefinition**(`namespaces`): `Promise`<`Record`<`string`, `IRoleDefinition`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespaces` | `string`[] | - -#### Returns - -`Promise`<`Record`<`string`, `IRoleDefinition`\>\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getRolesDefinition](../interfaces/ICacheClient.md#getrolesdefinition) - -___ - -### getSubOrganizationsByOrganization - -▸ **getSubOrganizationsByOrganization**(`namespace`): `Promise`<[`IOrganization`](../interfaces/IOrganization.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | - -#### Returns - -`Promise`<[`IOrganization`](../interfaces/IOrganization.md)[]\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[getSubOrganizationsByOrganization](../interfaces/ICacheClient.md#getsuborganizationsbyorganization) - -___ - -### handleError - -▸ **handleError**(`error`): `Promise`<`unknown`\> - -**`description`** Interceptor of authentication errors. Queues failed requests and starts authentication process. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `error` | `AxiosError`<`any`, `any`\> | Intercepted response from failed request | - -#### Returns - -`Promise`<`unknown`\> - -Promise, which resolves with result of resending of failed request - -___ - -### init - -▸ **init**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -___ - -### isAuthEnabled - -▸ **isAuthEnabled**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[isAuthEnabled](../interfaces/ICacheClient.md#isauthenabled) - -___ - -### issueClaim - -▸ **issueClaim**(`issuer`, `message`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `issuer` | `string` | -| `message` | [`IClaimIssuance`](../interfaces/IClaimIssuance.md) | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[issueClaim](../interfaces/ICacheClient.md#issueclaim) - -___ - -### login - -▸ **login**(): `Promise`<`void`\> - -Verifies current session and establishes new one if needed -https://energyweb.atlassian.net/wiki/spaces/MYEN/pages/2303295607/ICL-+ICS+Auth+Process - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[login](../interfaces/ICacheClient.md#login) - -___ - -### rejectClaim - -▸ **rejectClaim**(`issuer`, `message`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `issuer` | `string` | -| `message` | [`IClaimRejection`](../interfaces/IClaimRejection.md) | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[rejectClaim](../interfaces/ICacheClient.md#rejectclaim) - -___ - -### requestClaim - -▸ **requestClaim**(`message`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | [`IClaimRequest`](../interfaces/IClaimRequest.md) | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[ICacheClient](../interfaces/ICacheClient.md).[requestClaim](../interfaces/ICacheClient.md#requestclaim) diff --git a/docs/api/classes/ChangeOwnershipNotPossibleError.md b/docs/api/classes/ChangeOwnershipNotPossibleError.md deleted file mode 100644 index 715b3e31..00000000 --- a/docs/api/classes/ChangeOwnershipNotPossibleError.md +++ /dev/null @@ -1,31 +0,0 @@ -# Class: ChangeOwnershipNotPossibleError - -## Hierarchy - -- `Error` - - ↳ **`ChangeOwnershipNotPossibleError`** - -## Table of contents - -### Constructors - -- [constructor](ChangeOwnershipNotPossibleError.md#constructor) - -## Constructors - -### constructor - -• **new ChangeOwnershipNotPossibleError**(`__namedParameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | -| `__namedParameters.notOwnedNamespaces` | `string`[] | - -#### Overrides - -Error.constructor diff --git a/docs/api/classes/DeletingNamespaceNotPossibleError.md b/docs/api/classes/DeletingNamespaceNotPossibleError.md deleted file mode 100644 index 608e92c8..00000000 --- a/docs/api/classes/DeletingNamespaceNotPossibleError.md +++ /dev/null @@ -1,31 +0,0 @@ -# Class: DeletingNamespaceNotPossibleError - -## Hierarchy - -- `Error` - - ↳ **`DeletingNamespaceNotPossibleError`** - -## Table of contents - -### Constructors - -- [constructor](DeletingNamespaceNotPossibleError.md#constructor) - -## Constructors - -### constructor - -• **new DeletingNamespaceNotPossibleError**(`__namedParameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.namespace` | `string` | -| `__namedParameters.notOwnedNamespaces` | `string`[] | - -#### Overrides - -Error.constructor diff --git a/docs/api/classes/ENSOwnerNotValidAddressError.md b/docs/api/classes/ENSOwnerNotValidAddressError.md deleted file mode 100644 index e9225172..00000000 --- a/docs/api/classes/ENSOwnerNotValidAddressError.md +++ /dev/null @@ -1,29 +0,0 @@ -# Class: ENSOwnerNotValidAddressError - -## Hierarchy - -- `Error` - - ↳ **`ENSOwnerNotValidAddressError`** - -## Table of contents - -### Constructors - -- [constructor](ENSOwnerNotValidAddressError.md#constructor) - -## Constructors - -### constructor - -• **new ENSOwnerNotValidAddressError**(`providedOwner`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `providedOwner` | `string` | - -#### Overrides - -Error.constructor diff --git a/docs/api/classes/ENSTypeNotSupportedError.md b/docs/api/classes/ENSTypeNotSupportedError.md deleted file mode 100644 index debef9fb..00000000 --- a/docs/api/classes/ENSTypeNotSupportedError.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ENSTypeNotSupportedError - -## Hierarchy - -- `Error` - - ↳ **`ENSTypeNotSupportedError`** - -## Table of contents - -### Constructors - -- [constructor](ENSTypeNotSupportedError.md#constructor) - -## Constructors - -### constructor - -• **new ENSTypeNotSupportedError**() - -#### Overrides - -Error.constructor diff --git a/docs/api/classes/MalformedDIDError.md b/docs/api/classes/MalformedDIDError.md deleted file mode 100644 index 7c2e929d..00000000 --- a/docs/api/classes/MalformedDIDError.md +++ /dev/null @@ -1,29 +0,0 @@ -# Class: MalformedDIDError - -## Hierarchy - -- `Error` - - ↳ **`MalformedDIDError`** - -## Table of contents - -### Constructors - -- [constructor](MalformedDIDError.md#constructor) - -## Constructors - -### constructor - -• **new MalformedDIDError**(`did`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Overrides - -Error.constructor diff --git a/docs/api/classes/MethodNotAvailableInNodeEnvError.md b/docs/api/classes/MethodNotAvailableInNodeEnvError.md deleted file mode 100644 index 44499584..00000000 --- a/docs/api/classes/MethodNotAvailableInNodeEnvError.md +++ /dev/null @@ -1,29 +0,0 @@ -# Class: MethodNotAvailableInNodeEnvError - -## Hierarchy - -- `Error` - - ↳ **`MethodNotAvailableInNodeEnvError`** - -## Table of contents - -### Constructors - -- [constructor](MethodNotAvailableInNodeEnvError.md#constructor) - -## Constructors - -### constructor - -• **new MethodNotAvailableInNodeEnvError**(`methodName`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Overrides - -Error.constructor diff --git a/docs/api/classes/StakingFactoryService.md b/docs/api/classes/StakingFactoryService.md deleted file mode 100644 index 2c6dbdfd..00000000 --- a/docs/api/classes/StakingFactoryService.md +++ /dev/null @@ -1,69 +0,0 @@ -# Class: StakingFactoryService - -Intended for staking pool - -## Table of contents - -### Constructors - -- [constructor](StakingFactoryService.md#constructor) - -### Methods - -- [allServices](StakingFactoryService.md#allservices) -- [getPool](StakingFactoryService.md#getpool) -- [create](StakingFactoryService.md#create) - -## Constructors - -### constructor - -• **new StakingFactoryService**(`_signerService`, `_domainsService`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_signerService` | [`SignerService`](SignerService.md) | -| `_domainsService` | [`DomainsService`](DomainsService.md) | - -## Methods - -### allServices - -▸ **allServices**(): `Promise`<[`Service`](../modules.md#service)[]\> - -**`description`** Returns all services for which pools are launched - -#### Returns - -`Promise`<[`Service`](../modules.md#service)[]\> - -___ - -### getPool - -▸ **getPool**(): `Promise`<[`StakingPoolService`](StakingPoolService.md)\> - -**`description`** Returns pool launched for energyweb org - -#### Returns - -`Promise`<[`StakingPoolService`](StakingPoolService.md)\> - -___ - -### create - -▸ `Static` **create**(`signerService`, `domainsService`): `Promise`<[`StakingFactoryService`](StakingFactoryService.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerService` | [`SignerService`](SignerService.md) | -| `domainsService` | [`DomainsService`](DomainsService.md) | - -#### Returns - -`Promise`<[`StakingFactoryService`](StakingFactoryService.md)\> diff --git a/docs/api/classes/VerifiableCredentialsServiceBase.md b/docs/api/classes/VerifiableCredentialsServiceBase.md deleted file mode 100644 index b6e1a553..00000000 --- a/docs/api/classes/VerifiableCredentialsServiceBase.md +++ /dev/null @@ -1,117 +0,0 @@ -# Class: VerifiableCredentialsServiceBase - -## Table of contents - -### Constructors - -- [constructor](VerifiableCredentialsServiceBase.md#constructor) - -### Methods - -- [createPresentation](VerifiableCredentialsServiceBase.md#createpresentation) -- [createRoleVC](VerifiableCredentialsServiceBase.md#createrolevc) -- [createVerifiablePresentation](VerifiableCredentialsServiceBase.md#createverifiablepresentation) -- [verify](VerifiableCredentialsServiceBase.md#verify) -- [create](VerifiableCredentialsServiceBase.md#create) - -## Constructors - -### constructor - -• **new VerifiableCredentialsServiceBase**(`_signerService`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_signerService` | [`SignerService`](SignerService.md) | - -## Methods - -### createPresentation - -▸ **createPresentation**(`verifiableCredential`, `options?`): `Presentation` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `verifiableCredential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/RoleCredentialSubject.md)\>[] | -| `options?` | [`CreatePresentationParams`](../interfaces/CreatePresentationParams.md) | - -#### Returns - -`Presentation` - -___ - -### createRoleVC - -▸ **createRoleVC**(`credentialParams`, `proofOptions?`): `Promise`<`VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/RoleCredentialSubject.md)\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `credentialParams` | [`RoleCredentialSubjectParams`](../interfaces/RoleCredentialSubjectParams.md) | -| `proofOptions?` | [`ProofOptions`](../interfaces/ProofOptions.md) | - -#### Returns - -`Promise`<`VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/RoleCredentialSubject.md)\>\> - -___ - -### createVerifiablePresentation - -▸ **createVerifiablePresentation**(`verifiableCredential`, `options?`): `Promise`<`VerifiablePresentation`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `verifiableCredential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/RoleCredentialSubject.md)\>[] | -| `options?` | [`ProofOptions`](../interfaces/ProofOptions.md) | - -#### Returns - -`Promise`<`VerifiablePresentation`\> - -___ - -### verify - -▸ **verify**<`T`\>(`vp`, `options?`): `any` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `ICredentialSubject` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vp` | `VerifiablePresentation` \| `VerifiableCredential`<`T`\> | -| `options?` | [`ProofOptions`](../interfaces/ProofOptions.md) | - -#### Returns - -`any` - -___ - -### create - -▸ `Static` **create**(`signerService`): `Promise`<[`VerifiableCredentialsServiceBase`](VerifiableCredentialsServiceBase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerService` | [`SignerService`](SignerService.md) | - -#### Returns - -`Promise`<[`VerifiableCredentialsServiceBase`](VerifiableCredentialsServiceBase.md)\> diff --git a/docs/api/classes/AssetsService.md b/docs/api/classes/modules_assets.AssetsService.md similarity index 62% rename from docs/api/classes/AssetsService.md rename to docs/api/classes/modules_assets.AssetsService.md index fd1c9cc8..9e23ae7e 100644 --- a/docs/api/classes/AssetsService.md +++ b/docs/api/classes/modules_assets.AssetsService.md @@ -1,25 +1,27 @@ # Class: AssetsService +[modules/assets](../modules/modules_assets.md).AssetsService + ## Table of contents ### Constructors -- [constructor](AssetsService.md#constructor) +- [constructor](modules_assets.AssetsService.md#constructor) ### Methods -- [acceptAssetOffer](AssetsService.md#acceptassetoffer) -- [cancelAssetOffer](AssetsService.md#cancelassetoffer) -- [getAssetById](AssetsService.md#getassetbyid) -- [getAssetHistory](AssetsService.md#getassethistory) -- [getOfferedAssets](AssetsService.md#getofferedassets) -- [getOwnedAssets](AssetsService.md#getownedassets) -- [getPreviouslyOwnedAssets](AssetsService.md#getpreviouslyownedassets) -- [init](AssetsService.md#init) -- [offerAsset](AssetsService.md#offerasset) -- [registerAsset](AssetsService.md#registerasset) -- [rejectAssetOffer](AssetsService.md#rejectassetoffer) -- [create](AssetsService.md#create) +- [acceptAssetOffer](modules_assets.AssetsService.md#acceptassetoffer) +- [cancelAssetOffer](modules_assets.AssetsService.md#cancelassetoffer) +- [getAssetById](modules_assets.AssetsService.md#getassetbyid) +- [getAssetHistory](modules_assets.AssetsService.md#getassethistory) +- [getOfferedAssets](modules_assets.AssetsService.md#getofferedassets) +- [getOwnedAssets](modules_assets.AssetsService.md#getownedassets) +- [getPreviouslyOwnedAssets](modules_assets.AssetsService.md#getpreviouslyownedassets) +- [init](modules_assets.AssetsService.md#init) +- [offerAsset](modules_assets.AssetsService.md#offerasset) +- [registerAsset](modules_assets.AssetsService.md#registerasset) +- [rejectAssetOffer](modules_assets.AssetsService.md#rejectassetoffer) +- [create](modules_assets.AssetsService.md#create) ## Constructors @@ -31,8 +33,8 @@ | Name | Type | | :------ | :------ | -| `_signerService` | [`SignerService`](SignerService.md) | -| `_cacheClient` | [`CacheClient`](CacheClient.md) | +| `_signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `_cacheClient` | [`CacheClient`](modules_cacheClient.CacheClient.md) | ## Methods @@ -76,7 +78,7 @@ ___ ### getAssetById -▸ **getAssetById**(`id`): `Promise`<[`Asset`](../interfaces/Asset.md)\> +▸ **getAssetById**(`id`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\> **`description`** Get Asset by Id @@ -89,7 +91,7 @@ ___ #### Returns -`Promise`<[`Asset`](../interfaces/Asset.md)\> +`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\> Asset @@ -97,7 +99,7 @@ ___ ### getAssetHistory -▸ **getAssetHistory**(`__namedParameters`): `Promise`<[`AssetHistory`](../interfaces/AssetHistory.md)[]\> +▸ **getAssetHistory**(`__namedParameters`): `Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> **`description`** Get history of a given Asset Id @@ -107,14 +109,14 @@ ___ | :------ | :------ | | `__namedParameters` | `Object` | | `__namedParameters.id` | `string` | -| `__namedParameters.order?` | [`Order`](../enums/Order.md) | +| `__namedParameters.order?` | [`Order`](../enums/modules_cacheClient.Order.md) | | `__namedParameters.skip?` | `number` | | `__namedParameters.take?` | `number` | -| `__namedParameters.type?` | [`AssetHistoryEventType`](../enums/AssetHistoryEventType.md) | +| `__namedParameters.type?` | [`AssetHistoryEventType`](../enums/modules_assets.AssetHistoryEventType.md) | #### Returns -`Promise`<[`AssetHistory`](../interfaces/AssetHistory.md)[]\> +`Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> Asset[] || [] @@ -122,7 +124,7 @@ ___ ### getOfferedAssets -▸ **getOfferedAssets**(`__namedParameters?`): `Promise`<[`Asset`](../interfaces/Asset.md)[]\> +▸ **getOfferedAssets**(`__namedParameters?`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> **`description`** Get all Assets offered to current User @@ -135,7 +137,7 @@ ___ #### Returns -`Promise`<[`Asset`](../interfaces/Asset.md)[]\> +`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> Asset[] || [] @@ -143,7 +145,7 @@ ___ ### getOwnedAssets -▸ **getOwnedAssets**(`__namedParameters?`): `Promise`<[`Asset`](../interfaces/Asset.md)[]\> +▸ **getOwnedAssets**(`__namedParameters?`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> **`description`** Retrieve all owned assets for the User's DID @@ -156,13 +158,13 @@ ___ #### Returns -`Promise`<[`Asset`](../interfaces/Asset.md)[]\> +`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> ___ ### getPreviouslyOwnedAssets -▸ **getPreviouslyOwnedAssets**(`__namedParameters`): `Promise`<[`Asset`](../interfaces/Asset.md)[]\> +▸ **getPreviouslyOwnedAssets**(`__namedParameters`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> **`description`** Get previously owned asset for a given DID @@ -175,7 +177,7 @@ ___ #### Returns -`Promise`<[`Asset`](../interfaces/Asset.md)[]\> +`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> Asset[] || [] @@ -246,15 +248,15 @@ ___ ### create -▸ `Static` **create**(`signerService`, `cacheClient`): `Promise`<[`AssetsService`](AssetsService.md)\> +▸ `Static` **create**(`signerService`, `cacheClient`): `Promise`<[`AssetsService`](modules_assets.AssetsService.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `signerService` | [`SignerService`](SignerService.md) | -| `cacheClient` | [`CacheClient`](CacheClient.md) | +| `signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `cacheClient` | [`CacheClient`](modules_cacheClient.CacheClient.md) | #### Returns -`Promise`<[`AssetsService`](AssetsService.md)\> +`Promise`<[`AssetsService`](modules_assets.AssetsService.md)\> diff --git a/docs/api/classes/modules_cacheClient.CacheClient.md b/docs/api/classes/modules_cacheClient.CacheClient.md new file mode 100644 index 00000000..ff7eea96 --- /dev/null +++ b/docs/api/classes/modules_cacheClient.CacheClient.md @@ -0,0 +1,778 @@ +# Class: CacheClient + +[modules/cacheClient](../modules/modules_cacheClient.md).CacheClient + +## Implements + +- [`ICacheClient`](../interfaces/modules_cacheClient.ICacheClient.md) + +## Table of contents + +### Constructors + +- [constructor](modules_cacheClient.CacheClient.md#constructor) + +### Properties + +- [pubKeyAndIdentityToken](modules_cacheClient.CacheClient.md#pubkeyandidentitytoken) + +### Methods + +- [addDIDToWatchList](modules_cacheClient.CacheClient.md#adddidtowatchlist) +- [authenticate](modules_cacheClient.CacheClient.md#authenticate) +- [deleteClaim](modules_cacheClient.CacheClient.md#deleteclaim) +- [getAllowedRolesByIssuer](modules_cacheClient.CacheClient.md#getallowedrolesbyissuer) +- [getAppDefinition](modules_cacheClient.CacheClient.md#getappdefinition) +- [getApplicationRoles](modules_cacheClient.CacheClient.md#getapplicationroles) +- [getApplicationsByOrganization](modules_cacheClient.CacheClient.md#getapplicationsbyorganization) +- [getApplicationsByOwner](modules_cacheClient.CacheClient.md#getapplicationsbyowner) +- [getAssetById](modules_cacheClient.CacheClient.md#getassetbyid) +- [getAssetHistory](modules_cacheClient.CacheClient.md#getassethistory) +- [getClaimById](modules_cacheClient.CacheClient.md#getclaimbyid) +- [getClaimsByIssuer](modules_cacheClient.CacheClient.md#getclaimsbyissuer) +- [getClaimsByRequester](modules_cacheClient.CacheClient.md#getclaimsbyrequester) +- [getClaimsBySubject](modules_cacheClient.CacheClient.md#getclaimsbysubject) +- [getClaimsBySubjects](modules_cacheClient.CacheClient.md#getclaimsbysubjects) +- [getDIDsForRole](modules_cacheClient.CacheClient.md#getdidsforrole) +- [getDidDocument](modules_cacheClient.CacheClient.md#getdiddocument) +- [getNamespaceBySearchPhrase](modules_cacheClient.CacheClient.md#getnamespacebysearchphrase) +- [getOfferedAssets](modules_cacheClient.CacheClient.md#getofferedassets) +- [getOrgDefinition](modules_cacheClient.CacheClient.md#getorgdefinition) +- [getOrgHierarchy](modules_cacheClient.CacheClient.md#getorghierarchy) +- [getOrganizationRoles](modules_cacheClient.CacheClient.md#getorganizationroles) +- [getOrganizationsByOwner](modules_cacheClient.CacheClient.md#getorganizationsbyowner) +- [getOwnedAssets](modules_cacheClient.CacheClient.md#getownedassets) +- [getPreviouslyOwnedAssets](modules_cacheClient.CacheClient.md#getpreviouslyownedassets) +- [getRoleDefinition](modules_cacheClient.CacheClient.md#getroledefinition) +- [getRolesByOwner](modules_cacheClient.CacheClient.md#getrolesbyowner) +- [getRolesDefinition](modules_cacheClient.CacheClient.md#getrolesdefinition) +- [getSubOrganizationsByOrganization](modules_cacheClient.CacheClient.md#getsuborganizationsbyorganization) +- [handleError](modules_cacheClient.CacheClient.md#handleerror) +- [init](modules_cacheClient.CacheClient.md#init) +- [isAuthEnabled](modules_cacheClient.CacheClient.md#isauthenabled) +- [issueClaim](modules_cacheClient.CacheClient.md#issueclaim) +- [login](modules_cacheClient.CacheClient.md#login) +- [rejectClaim](modules_cacheClient.CacheClient.md#rejectclaim) +- [requestClaim](modules_cacheClient.CacheClient.md#requestclaim) + +## Constructors + +### constructor + +• **new CacheClient**(`_signerService`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_signerService` | [`SignerService`](modules_signer.SignerService.md) | + +## Properties + +### pubKeyAndIdentityToken + +• **pubKeyAndIdentityToken**: `undefined` \| [`IPubKeyAndIdentityToken`](../interfaces/modules_signer.IPubKeyAndIdentityToken.md) + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[pubKeyAndIdentityToken](../interfaces/modules_cacheClient.ICacheClient.md#pubkeyandidentitytoken) + +## Methods + +### addDIDToWatchList + +▸ **addDIDToWatchList**(`did`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `did` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[addDIDToWatchList](../interfaces/modules_cacheClient.ICacheClient.md#adddidtowatchlist) + +___ + +### authenticate + +▸ **authenticate**(): `Promise`<`void`\> + +**`description`** Refreshes access token. If login still fails then signs new identity token and requests access token +After authentication runs previously failed requests + +#### Returns + +`Promise`<`void`\> + +___ + +### deleteClaim + +▸ **deleteClaim**(`id`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[deleteClaim](../interfaces/modules_cacheClient.ICacheClient.md#deleteclaim) + +___ + +### getAllowedRolesByIssuer + +▸ **getAllowedRolesByIssuer**(`did`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `did` | `string` | + +#### Returns + +`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> + +___ + +### getAppDefinition + +▸ **getAppDefinition**(`namespace`): `Promise`<`IAppDefinition`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<`IAppDefinition`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getAppDefinition](../interfaces/modules_cacheClient.ICacheClient.md#getappdefinition) + +___ + +### getApplicationRoles + +▸ **getApplicationRoles**(`namespace`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getApplicationRoles](../interfaces/modules_cacheClient.ICacheClient.md#getapplicationroles) + +___ + +### getApplicationsByOrganization + +▸ **getApplicationsByOrganization**(`namespace`): `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getApplicationsByOrganization](../interfaces/modules_cacheClient.ICacheClient.md#getapplicationsbyorganization) + +___ + +### getApplicationsByOwner + +▸ **getApplicationsByOwner**(`owner`, `withRelations?`): `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `owner` | `string` | `undefined` | +| `withRelations` | `boolean` | `true` | + +#### Returns + +`Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getApplicationsByOwner](../interfaces/modules_cacheClient.ICacheClient.md#getapplicationsbyowner) + +___ + +### getAssetById + +▸ **getAssetById**(`id`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getAssetById](../interfaces/modules_cacheClient.ICacheClient.md#getassetbyid) + +___ + +### getAssetHistory + +▸ **getAssetHistory**(`id`, `__namedParameters?`): `Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `__namedParameters` | [`AssetsFilter`](../modules/modules_cacheClient.md#assetsfilter) | + +#### Returns + +`Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getAssetHistory](../interfaces/modules_cacheClient.ICacheClient.md#getassethistory) + +___ + +### getClaimById + +▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `claimId` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getClaimById](../interfaces/modules_cacheClient.ICacheClient.md#getclaimbyid) + +___ + +### getClaimsByIssuer + +▸ **getClaimsByIssuer**(`issuer`, `__namedParameters?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `issuer` | `string` | +| `__namedParameters` | [`ClaimsFilter`](../modules/modules_cacheClient.md#claimsfilter) | + +#### Returns + +`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getClaimsByIssuer](../interfaces/modules_cacheClient.ICacheClient.md#getclaimsbyissuer) + +___ + +### getClaimsByRequester + +▸ **getClaimsByRequester**(`requester`, `__namedParameters?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `requester` | `string` | +| `__namedParameters` | [`ClaimsFilter`](../modules/modules_cacheClient.md#claimsfilter) | + +#### Returns + +`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getClaimsByRequester](../interfaces/modules_cacheClient.ICacheClient.md#getclaimsbyrequester) + +___ + +### getClaimsBySubject + +▸ **getClaimsBySubject**(`subject`, `__namedParameters?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subject` | `string` | +| `__namedParameters` | [`ClaimsFilter`](../modules/modules_cacheClient.md#claimsfilter) | + +#### Returns + +`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getClaimsBySubject](../interfaces/modules_cacheClient.ICacheClient.md#getclaimsbysubject) + +___ + +### getClaimsBySubjects + +▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subjects` | `string`[] | + +#### Returns + +`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getClaimsBySubjects](../interfaces/modules_cacheClient.ICacheClient.md#getclaimsbysubjects) + +___ + +### getDIDsForRole + +▸ **getDIDsForRole**(`namespace`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getDIDsForRole](../interfaces/modules_cacheClient.ICacheClient.md#getdidsforrole) + +___ + +### getDidDocument + +▸ **getDidDocument**(`did`, `includeClaims?`): `Promise`<`IDIDDocument`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `did` | `string` | +| `includeClaims?` | `boolean` | + +#### Returns + +`Promise`<`IDIDDocument`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getDidDocument](../interfaces/modules_cacheClient.ICacheClient.md#getdiddocument) + +___ + +### getNamespaceBySearchPhrase + +▸ **getNamespaceBySearchPhrase**(`search`, `types?`): `Promise`<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `search` | `string` | +| `types?` | [`SearchType`](../enums/modules_cacheClient.SearchType.md)[] | + +#### Returns + +`Promise`<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getNamespaceBySearchPhrase](../interfaces/modules_cacheClient.ICacheClient.md#getnamespacebysearchphrase) + +___ + +### getOfferedAssets + +▸ **getOfferedAssets**(`did`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `did` | `string` | + +#### Returns + +`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getOfferedAssets](../interfaces/modules_cacheClient.ICacheClient.md#getofferedassets) + +___ + +### getOrgDefinition + +▸ **getOrgDefinition**(`namespace`): `Promise`<`IOrganizationDefinition`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<`IOrganizationDefinition`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getOrgDefinition](../interfaces/modules_cacheClient.ICacheClient.md#getorgdefinition) + +___ + +### getOrgHierarchy + +▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getOrgHierarchy](../interfaces/modules_cacheClient.ICacheClient.md#getorghierarchy) + +___ + +### getOrganizationRoles + +▸ **getOrganizationRoles**(`namespace`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getOrganizationRoles](../interfaces/modules_cacheClient.ICacheClient.md#getorganizationroles) + +___ + +### getOrganizationsByOwner + +▸ **getOrganizationsByOwner**(`owner`, `withRelations?`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `owner` | `string` | `undefined` | +| `withRelations` | `boolean` | `true` | + +#### Returns + +`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getOrganizationsByOwner](../interfaces/modules_cacheClient.ICacheClient.md#getorganizationsbyowner) + +___ + +### getOwnedAssets + +▸ **getOwnedAssets**(`did`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `did` | `string` | + +#### Returns + +`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getOwnedAssets](../interfaces/modules_cacheClient.ICacheClient.md#getownedassets) + +___ + +### getPreviouslyOwnedAssets + +▸ **getPreviouslyOwnedAssets**(`owner`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner` | `string` | + +#### Returns + +`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getPreviouslyOwnedAssets](../interfaces/modules_cacheClient.ICacheClient.md#getpreviouslyownedassets) + +___ + +### getRoleDefinition + +▸ **getRoleDefinition**(`namespace`): `Promise`<`IRoleDefinition`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<`IRoleDefinition`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getRoleDefinition](../interfaces/modules_cacheClient.ICacheClient.md#getroledefinition) + +___ + +### getRolesByOwner + +▸ **getRolesByOwner**(`owner`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner` | `string` | + +#### Returns + +`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getRolesByOwner](../interfaces/modules_cacheClient.ICacheClient.md#getrolesbyowner) + +___ + +### getRolesDefinition + +▸ **getRolesDefinition**(`namespaces`): `Promise`<`Record`<`string`, `IRoleDefinition`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespaces` | `string`[] | + +#### Returns + +`Promise`<`Record`<`string`, `IRoleDefinition`\>\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getRolesDefinition](../interfaces/modules_cacheClient.ICacheClient.md#getrolesdefinition) + +___ + +### getSubOrganizationsByOrganization + +▸ **getSubOrganizationsByOrganization**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[getSubOrganizationsByOrganization](../interfaces/modules_cacheClient.ICacheClient.md#getsuborganizationsbyorganization) + +___ + +### handleError + +▸ **handleError**(`error`): `Promise`<`unknown`\> + +**`description`** Interceptor of authentication errors. Queues failed requests and starts authentication process. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `error` | `AxiosError`<`any`, `any`\> | Intercepted response from failed request | + +#### Returns + +`Promise`<`unknown`\> + +Promise, which resolves with result of resending of failed request + +___ + +### init + +▸ **init**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +___ + +### isAuthEnabled + +▸ **isAuthEnabled**(): `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[isAuthEnabled](../interfaces/modules_cacheClient.ICacheClient.md#isauthenabled) + +___ + +### issueClaim + +▸ **issueClaim**(`issuer`, `message`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `issuer` | `string` | +| `message` | [`IClaimIssuance`](../interfaces/modules_claims.IClaimIssuance.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[issueClaim](../interfaces/modules_cacheClient.ICacheClient.md#issueclaim) + +___ + +### login + +▸ **login**(): `Promise`<`void`\> + +Verifies current session and establishes new one if needed +https://energyweb.atlassian.net/wiki/spaces/MYEN/pages/2303295607/ICL-+ICS+Auth+Process + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[login](../interfaces/modules_cacheClient.ICacheClient.md#login) + +___ + +### rejectClaim + +▸ **rejectClaim**(`issuer`, `message`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `issuer` | `string` | +| `message` | [`IClaimRejection`](../interfaces/modules_claims.IClaimRejection.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[rejectClaim](../interfaces/modules_cacheClient.ICacheClient.md#rejectclaim) + +___ + +### requestClaim + +▸ **requestClaim**(`message`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | [`IClaimRequest`](../interfaces/modules_claims.IClaimRequest.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md).[requestClaim](../interfaces/modules_cacheClient.ICacheClient.md#requestclaim) diff --git a/docs/api/classes/ClaimsService.md b/docs/api/classes/modules_claims.ClaimsService.md similarity index 71% rename from docs/api/classes/ClaimsService.md rename to docs/api/classes/modules_claims.ClaimsService.md index 1051fc18..8acbd463 100644 --- a/docs/api/classes/ClaimsService.md +++ b/docs/api/classes/modules_claims.ClaimsService.md @@ -1,34 +1,36 @@ # Class: ClaimsService +[modules/claims](../modules/modules_claims.md).ClaimsService + ## Table of contents ### Constructors -- [constructor](ClaimsService.md#constructor) +- [constructor](modules_claims.ClaimsService.md#constructor) ### Methods -- [createClaimRequest](ClaimsService.md#createclaimrequest) -- [createDelegateProof](ClaimsService.md#createdelegateproof) -- [createIdentityProof](ClaimsService.md#createidentityproof) -- [createSelfSignedClaim](ClaimsService.md#createselfsignedclaim) -- [deleteClaim](ClaimsService.md#deleteclaim) -- [getClaimById](ClaimsService.md#getclaimbyid) -- [getClaimId](ClaimsService.md#getclaimid) -- [getClaimsByIssuer](ClaimsService.md#getclaimsbyissuer) -- [getClaimsByRequester](ClaimsService.md#getclaimsbyrequester) -- [getClaimsBySubject](ClaimsService.md#getclaimsbysubject) -- [getClaimsBySubjects](ClaimsService.md#getclaimsbysubjects) -- [getNamespaceFromClaimType](ClaimsService.md#getnamespacefromclaimtype) -- [getUserClaims](ClaimsService.md#getuserclaims) -- [hasOnChainRole](ClaimsService.md#hasonchainrole) -- [init](ClaimsService.md#init) -- [issueClaim](ClaimsService.md#issueclaim) -- [issueClaimRequest](ClaimsService.md#issueclaimrequest) -- [publishPublicClaim](ClaimsService.md#publishpublicclaim) -- [registerOnchain](ClaimsService.md#registeronchain) -- [rejectClaimRequest](ClaimsService.md#rejectclaimrequest) -- [create](ClaimsService.md#create) +- [createClaimRequest](modules_claims.ClaimsService.md#createclaimrequest) +- [createDelegateProof](modules_claims.ClaimsService.md#createdelegateproof) +- [createIdentityProof](modules_claims.ClaimsService.md#createidentityproof) +- [createSelfSignedClaim](modules_claims.ClaimsService.md#createselfsignedclaim) +- [deleteClaim](modules_claims.ClaimsService.md#deleteclaim) +- [getClaimById](modules_claims.ClaimsService.md#getclaimbyid) +- [getClaimId](modules_claims.ClaimsService.md#getclaimid) +- [getClaimsByIssuer](modules_claims.ClaimsService.md#getclaimsbyissuer) +- [getClaimsByRequester](modules_claims.ClaimsService.md#getclaimsbyrequester) +- [getClaimsBySubject](modules_claims.ClaimsService.md#getclaimsbysubject) +- [getClaimsBySubjects](modules_claims.ClaimsService.md#getclaimsbysubjects) +- [getNamespaceFromClaimType](modules_claims.ClaimsService.md#getnamespacefromclaimtype) +- [getUserClaims](modules_claims.ClaimsService.md#getuserclaims) +- [hasOnChainRole](modules_claims.ClaimsService.md#hasonchainrole) +- [init](modules_claims.ClaimsService.md#init) +- [issueClaim](modules_claims.ClaimsService.md#issueclaim) +- [issueClaimRequest](modules_claims.ClaimsService.md#issueclaimrequest) +- [publishPublicClaim](modules_claims.ClaimsService.md#publishpublicclaim) +- [registerOnchain](modules_claims.ClaimsService.md#registeronchain) +- [rejectClaimRequest](modules_claims.ClaimsService.md#rejectclaimrequest) +- [create](modules_claims.ClaimsService.md#create) ## Constructors @@ -40,11 +42,11 @@ | Name | Type | | :------ | :------ | -| `_signerService` | [`SignerService`](SignerService.md) | -| `_domainsService` | [`DomainsService`](DomainsService.md) | -| `_cacheClient` | [`CacheClient`](CacheClient.md) | -| `_didRegistry` | [`DidRegistry`](DidRegistry.md) | -| `_verifiableCredentialService` | [`VerifiableCredentialsServiceBase`](VerifiableCredentialsServiceBase.md) | +| `_signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `_domainsService` | [`DomainsService`](modules_domains.DomainsService.md) | +| `_cacheClient` | [`CacheClient`](modules_cacheClient.CacheClient.md) | +| `_didRegistry` | [`DidRegistry`](modules_didRegistry.DidRegistry.md) | +| `_verifiableCredentialService` | [`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) | ## Methods @@ -64,7 +66,7 @@ | `__namedParameters.claim.claimTypeVersion` | `number` | | `__namedParameters.claim.issuerFields?` | { `key`: `string` ; `value`: `string` \| `number` }[] | | `__namedParameters.claim.requestorFields?` | { `key`: `string` ; `value`: `string` \| `number` }[] | -| `__namedParameters.registrationTypes?` | [`RegistrationTypes`](../enums/RegistrationTypes.md)[] | +| `__namedParameters.registrationTypes?` | [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[] | | `__namedParameters.subject?` | `string` | #### Returns @@ -120,7 +122,7 @@ ___ | Name | Type | | :------ | :------ | | `__namedParameters` | `Object` | -| `__namedParameters.data` | [`ClaimData`](../interfaces/ClaimData.md) | +| `__namedParameters.data` | [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md) | | `__namedParameters.subject?` | `string` | #### Returns @@ -150,7 +152,7 @@ ___ ### getClaimById -▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](../interfaces/Claim.md)\> +▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> **`description`** - Returns claim with the given Id or null if claim does not exist @@ -162,7 +164,7 @@ ___ #### Returns -`Promise`<`undefined` \| [`Claim`](../interfaces/Claim.md)\> +`Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims.Claim.md)\> ___ @@ -175,7 +177,7 @@ ___ | Name | Type | | :------ | :------ | | `__namedParameters` | `Object` | -| `__namedParameters.claimData` | [`ClaimData`](../interfaces/ClaimData.md) | +| `__namedParameters.claimData` | [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md) | #### Returns @@ -185,7 +187,7 @@ ___ ### getClaimsByIssuer -▸ **getClaimsByIssuer**(`__namedParameters`): `Promise`<[`Claim`](../interfaces/Claim.md)[]\> +▸ **getClaimsByIssuer**(`__namedParameters`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> **`description`** - Returns claims for given issuer. Allows filtering by status and parent namespace @@ -200,13 +202,13 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/Claim.md)[]\> +`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> ___ ### getClaimsByRequester -▸ **getClaimsByRequester**(`__namedParameters`): `Promise`<[`Claim`](../interfaces/Claim.md)[]\> +▸ **getClaimsByRequester**(`__namedParameters`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> **`description`** - Returns claims for given requester. Allows filtering by status and parent namespace @@ -221,13 +223,13 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/Claim.md)[]\> +`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> ___ ### getClaimsBySubject -▸ **getClaimsBySubject**(`__namedParameters`): `Promise`<[`Claim`](../interfaces/Claim.md)[]\> +▸ **getClaimsBySubject**(`__namedParameters`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> **`description`** - Returns claims for given subject. Allows filtering by status and parent namespace @@ -242,13 +244,13 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/Claim.md)[]\> +`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> ___ ### getClaimsBySubjects -▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](../interfaces/Claim.md)[]\> +▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> #### Parameters @@ -258,7 +260,7 @@ ___ #### Returns -`Promise`<[`Claim`](../interfaces/Claim.md)[]\> +`Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\> ___ @@ -284,7 +286,7 @@ ___ ### getUserClaims -▸ **getUserClaims**(`__namedParameters?`): `Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[]\> +▸ **getUserClaims**(`__namedParameters?`): `Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md)[]\> getUserClaims @@ -298,7 +300,7 @@ getUserClaims #### Returns -`Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[]\> +`Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md)[]\> ___ @@ -348,7 +350,7 @@ ___ | `__namedParameters.claim.claimType` | `string` | | `__namedParameters.claim.claimTypeVersion` | `number` | | `__namedParameters.claim.issuerFields` | { `key`: `string` ; `value`: `string` \| `number` }[] | -| `__namedParameters.registrationTypes` | [`RegistrationTypes`](../enums/RegistrationTypes.md)[] | +| `__namedParameters.registrationTypes` | [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[] | | `__namedParameters.subject` | `string` | #### Returns @@ -372,7 +374,7 @@ Optionally, issue on-chain role can be submitted to the ClaimManager contract as | `__namedParameters.id` | `string` | | `__namedParameters.issuerFields?` | { `key`: `string` ; `value`: `string` \| `number` }[] | | `__namedParameters.publishOnChain?` | `boolean` | -| `__namedParameters.registrationTypes` | [`RegistrationTypes`](../enums/RegistrationTypes.md)[] | +| `__namedParameters.registrationTypes` | [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[] | | `__namedParameters.requester` | `string` | | `__namedParameters.subjectAgreement` | `string` | | `__namedParameters.token` | `string` | @@ -397,7 +399,7 @@ ___ | `token.claim` | `Object` | - | | `token.claim.claimType?` | `string` | - | | `token.claim.token?` | `string` | - | -| `token.registrationTypes?` | [`RegistrationTypes`](../enums/RegistrationTypes.md)[] | - | +| `token.registrationTypes?` | [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[] | - | | `token.token?` | `string` | - | #### Returns @@ -454,18 +456,18 @@ ___ ### create -▸ `Static` **create**(`signerService`, `domainsService`, `cacheClient`, `didRegistry`, `verifiableCredentialService`): `Promise`<[`ClaimsService`](ClaimsService.md)\> +▸ `Static` **create**(`signerService`, `domainsService`, `cacheClient`, `didRegistry`, `verifiableCredentialService`): `Promise`<[`ClaimsService`](modules_claims.ClaimsService.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `signerService` | [`SignerService`](SignerService.md) | -| `domainsService` | [`DomainsService`](DomainsService.md) | -| `cacheClient` | [`CacheClient`](CacheClient.md) | -| `didRegistry` | [`DidRegistry`](DidRegistry.md) | -| `verifiableCredentialService` | [`VerifiableCredentialsServiceBase`](VerifiableCredentialsServiceBase.md) | +| `signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `domainsService` | [`DomainsService`](modules_domains.DomainsService.md) | +| `cacheClient` | [`CacheClient`](modules_cacheClient.CacheClient.md) | +| `didRegistry` | [`DidRegistry`](modules_didRegistry.DidRegistry.md) | +| `verifiableCredentialService` | [`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) | #### Returns -`Promise`<[`ClaimsService`](ClaimsService.md)\> +`Promise`<[`ClaimsService`](modules_claims.ClaimsService.md)\> diff --git a/docs/api/classes/DidRegistry.md b/docs/api/classes/modules_didRegistry.DidRegistry.md similarity index 70% rename from docs/api/classes/DidRegistry.md rename to docs/api/classes/modules_didRegistry.DidRegistry.md index 156bc62a..95398fb9 100644 --- a/docs/api/classes/DidRegistry.md +++ b/docs/api/classes/modules_didRegistry.DidRegistry.md @@ -1,33 +1,35 @@ # Class: DidRegistry +[modules/didRegistry](../modules/modules_didRegistry.md).DidRegistry + ## Table of contents ### Constructors -- [constructor](DidRegistry.md#constructor) +- [constructor](modules_didRegistry.DidRegistry.md#constructor) ### Accessors -- [ipfsStore](DidRegistry.md#ipfsstore) -- [jwt](DidRegistry.md#jwt) +- [ipfsStore](modules_didRegistry.DidRegistry.md#ipfsstore) +- [jwt](modules_didRegistry.DidRegistry.md#jwt) ### Methods -- [createDocument](DidRegistry.md#createdocument) -- [createPublicClaim](DidRegistry.md#createpublicclaim) -- [decodeJWTToken](DidRegistry.md#decodejwttoken) -- [getDidDelegates](DidRegistry.md#getdiddelegates) -- [getDidDocument](DidRegistry.md#getdiddocument) -- [getDidPublicKeys](DidRegistry.md#getdidpublickeys) -- [getServices](DidRegistry.md#getservices) -- [init](DidRegistry.md#init) -- [issuePublicClaim](DidRegistry.md#issuepublicclaim) -- [revokeDidDocument](DidRegistry.md#revokediddocument) -- [updateDocument](DidRegistry.md#updatedocument) -- [updateSignedDidDelegate](DidRegistry.md#updatesigneddiddelegate) -- [updateSignedDidPublicKey](DidRegistry.md#updatesigneddidpublickey) -- [verifyPublicClaim](DidRegistry.md#verifypublicclaim) -- [connect](DidRegistry.md#connect) +- [createDocument](modules_didRegistry.DidRegistry.md#createdocument) +- [createPublicClaim](modules_didRegistry.DidRegistry.md#createpublicclaim) +- [decodeJWTToken](modules_didRegistry.DidRegistry.md#decodejwttoken) +- [getDidDelegates](modules_didRegistry.DidRegistry.md#getdiddelegates) +- [getDidDocument](modules_didRegistry.DidRegistry.md#getdiddocument) +- [getDidPublicKeys](modules_didRegistry.DidRegistry.md#getdidpublickeys) +- [getServices](modules_didRegistry.DidRegistry.md#getservices) +- [init](modules_didRegistry.DidRegistry.md#init) +- [issuePublicClaim](modules_didRegistry.DidRegistry.md#issuepublicclaim) +- [revokeDidDocument](modules_didRegistry.DidRegistry.md#revokediddocument) +- [updateDocument](modules_didRegistry.DidRegistry.md#updatedocument) +- [updateSignedDidDelegate](modules_didRegistry.DidRegistry.md#updatesigneddiddelegate) +- [updateSignedDidPublicKey](modules_didRegistry.DidRegistry.md#updatesigneddidpublickey) +- [verifyPublicClaim](modules_didRegistry.DidRegistry.md#verifypublicclaim) +- [connect](modules_didRegistry.DidRegistry.md#connect) ## Constructors @@ -39,9 +41,9 @@ | Name | Type | Default value | | :------ | :------ | :------ | -| `_signerService` | [`SignerService`](SignerService.md) | `undefined` | -| `_cacheClient` | [`CacheClient`](CacheClient.md) | `undefined` | -| `_assetsService` | [`AssetsService`](AssetsService.md) | `undefined` | +| `_signerService` | [`SignerService`](modules_signer.SignerService.md) | `undefined` | +| `_cacheClient` | [`CacheClient`](modules_cacheClient.CacheClient.md) | `undefined` | +| `_assetsService` | [`AssetsService`](modules_assets.AssetsService.md) | `undefined` | | `_ipfsUrl` | `string` | `'https://ipfs.infura.io:5001/api/v0/'` | ## Accessors @@ -91,7 +93,7 @@ ___ | Name | Type | | :------ | :------ | | `__namedParameters` | `Object` | -| `__namedParameters.data` | [`ClaimData`](../interfaces/ClaimData.md) | +| `__namedParameters.data` | [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md) | | `__namedParameters.subject?` | `string` | #### Returns @@ -141,7 +143,7 @@ ___ ### getDidDocument -▸ **getDidDocument**(`__namedParameters?`): `Promise`<{ `service`: `IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[] }\> +▸ **getDidDocument**(`__namedParameters?`): `Promise`<{ `service`: `IServiceEndpoint` & [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md)[] }\> #### Parameters @@ -151,7 +153,7 @@ ___ #### Returns -`Promise`<{ `service`: `IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[] }\> +`Promise`<{ `service`: `IServiceEndpoint` & [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md)[] }\> ___ @@ -177,7 +179,7 @@ ___ ### getServices -▸ **getServices**(`__namedParameters?`): `Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[]\> +▸ **getServices**(`__namedParameters?`): `Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md)[]\> **`description`** gets list of services endpoints from User's DID document @@ -189,7 +191,7 @@ ___ #### Returns -`Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[]\> +`Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/modules_didRegistry.ClaimData.md)[]\> list of claims @@ -339,17 +341,17 @@ ___ ### connect -▸ `Static` **connect**(`signerService`, `cacheClient`, `assetsService`, `ipfsUrl?`): `Promise`<[`DidRegistry`](DidRegistry.md)\> +▸ `Static` **connect**(`signerService`, `cacheClient`, `assetsService`, `ipfsUrl?`): `Promise`<[`DidRegistry`](modules_didRegistry.DidRegistry.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `signerService` | [`SignerService`](SignerService.md) | -| `cacheClient` | [`CacheClient`](CacheClient.md) | -| `assetsService` | [`AssetsService`](AssetsService.md) | +| `signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `cacheClient` | [`CacheClient`](modules_cacheClient.CacheClient.md) | +| `assetsService` | [`AssetsService`](modules_assets.AssetsService.md) | | `ipfsUrl?` | `string` | #### Returns -`Promise`<[`DidRegistry`](DidRegistry.md)\> +`Promise`<[`DidRegistry`](modules_didRegistry.DidRegistry.md)\> diff --git a/docs/api/classes/DomainsService.md b/docs/api/classes/modules_domains.DomainsService.md similarity index 73% rename from docs/api/classes/DomainsService.md rename to docs/api/classes/modules_domains.DomainsService.md index ca5cce2c..081eda10 100644 --- a/docs/api/classes/DomainsService.md +++ b/docs/api/classes/modules_domains.DomainsService.md @@ -1,42 +1,44 @@ # Class: DomainsService +[modules/domains](../modules/modules_domains.md).DomainsService + ## Table of contents ### Constructors -- [constructor](DomainsService.md#constructor) +- [constructor](modules_domains.DomainsService.md#constructor) ### Methods -- [changeAppOwnership](DomainsService.md#changeappownership) -- [changeOrgOwnership](DomainsService.md#changeorgownership) -- [changeRoleOwnership](DomainsService.md#changeroleownership) -- [checkExistenceOfDomain](DomainsService.md#checkexistenceofdomain) -- [createApplication](DomainsService.md#createapplication) -- [createOrganization](DomainsService.md#createorganization) -- [createRole](DomainsService.md#createrole) -- [deleteApplication](DomainsService.md#deleteapplication) -- [deleteOrganization](DomainsService.md#deleteorganization) -- [deleteRole](DomainsService.md#deleterole) -- [getAllowedRolesByIssuer](DomainsService.md#getallowedrolesbyissuer) -- [getAppsOfOrg](DomainsService.md#getappsoforg) -- [getDIDsByRole](DomainsService.md#getdidsbyrole) -- [getDefinition](DomainsService.md#getdefinition) -- [getENSTypesByOwner](DomainsService.md#getenstypesbyowner) -- [getENSTypesBySearchPhrase](DomainsService.md#getenstypesbysearchphrase) -- [getOrgHierarchy](DomainsService.md#getorghierarchy) -- [getRolesByNamespace](DomainsService.md#getrolesbynamespace) -- [getSubOrgsByOrgNamespace](DomainsService.md#getsuborgsbyorgnamespace) -- [getSubdomains](DomainsService.md#getsubdomains) -- [init](DomainsService.md#init) -- [isOwner](DomainsService.md#isowner) -- [namespacesWithRelations](DomainsService.md#namespaceswithrelations) -- [readName](DomainsService.md#readname) -- [registrationTypesOfRoles](DomainsService.md#registrationtypesofroles) -- [setRoleDefinition](DomainsService.md#setroledefinition) -- [updateLegacyDefinition](DomainsService.md#updatelegacydefinition) -- [validateOwnership](DomainsService.md#validateownership) -- [create](DomainsService.md#create) +- [changeAppOwnership](modules_domains.DomainsService.md#changeappownership) +- [changeOrgOwnership](modules_domains.DomainsService.md#changeorgownership) +- [changeRoleOwnership](modules_domains.DomainsService.md#changeroleownership) +- [checkExistenceOfDomain](modules_domains.DomainsService.md#checkexistenceofdomain) +- [createApplication](modules_domains.DomainsService.md#createapplication) +- [createOrganization](modules_domains.DomainsService.md#createorganization) +- [createRole](modules_domains.DomainsService.md#createrole) +- [deleteApplication](modules_domains.DomainsService.md#deleteapplication) +- [deleteOrganization](modules_domains.DomainsService.md#deleteorganization) +- [deleteRole](modules_domains.DomainsService.md#deleterole) +- [getAllowedRolesByIssuer](modules_domains.DomainsService.md#getallowedrolesbyissuer) +- [getAppsOfOrg](modules_domains.DomainsService.md#getappsoforg) +- [getDIDsByRole](modules_domains.DomainsService.md#getdidsbyrole) +- [getDefinition](modules_domains.DomainsService.md#getdefinition) +- [getENSTypesByOwner](modules_domains.DomainsService.md#getenstypesbyowner) +- [getENSTypesBySearchPhrase](modules_domains.DomainsService.md#getenstypesbysearchphrase) +- [getOrgHierarchy](modules_domains.DomainsService.md#getorghierarchy) +- [getRolesByNamespace](modules_domains.DomainsService.md#getrolesbynamespace) +- [getSubOrgsByOrgNamespace](modules_domains.DomainsService.md#getsuborgsbyorgnamespace) +- [getSubdomains](modules_domains.DomainsService.md#getsubdomains) +- [init](modules_domains.DomainsService.md#init) +- [isOwner](modules_domains.DomainsService.md#isowner) +- [namespacesWithRelations](modules_domains.DomainsService.md#namespaceswithrelations) +- [readName](modules_domains.DomainsService.md#readname) +- [registrationTypesOfRoles](modules_domains.DomainsService.md#registrationtypesofroles) +- [setRoleDefinition](modules_domains.DomainsService.md#setroledefinition) +- [updateLegacyDefinition](modules_domains.DomainsService.md#updatelegacydefinition) +- [validateOwnership](modules_domains.DomainsService.md#validateownership) +- [create](modules_domains.DomainsService.md#create) ## Constructors @@ -48,8 +50,8 @@ | Name | Type | | :------ | :------ | -| `_signerService` | [`SignerService`](SignerService.md) | -| `_cacheClient` | [`CacheClient`](CacheClient.md) | +| `_signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `_cacheClient` | [`CacheClient`](modules_cacheClient.CacheClient.md) | ## Methods @@ -80,7 +82,7 @@ ___ ### changeOrgOwnership -▸ **changeOrgOwnership**(`__namedParameters`): `Promise`<`undefined` \| [`MulticallTx`](../modules.md#multicalltx)\> +▸ **changeOrgOwnership**(`__namedParameters`): `Promise`<`undefined` \| [`MulticallTx`](../modules/modules_domains.md#multicalltx)\> changeOrgOwnership @@ -98,7 +100,7 @@ changeOrgOwnership #### Returns -`Promise`<`undefined` \| [`MulticallTx`](../modules.md#multicalltx)\> +`Promise`<`undefined` \| [`MulticallTx`](../modules/modules_domains.md#multicalltx)\> return array of steps needed to change ownership @@ -294,7 +296,7 @@ ___ ### getAllowedRolesByIssuer -▸ **getAllowedRolesByIssuer**(`did`): `Promise`<[`IRole`](../interfaces/IRole.md)[]\> +▸ **getAllowedRolesByIssuer**(`did`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> getAllowedRolesByIssuer @@ -308,7 +310,7 @@ getAllowedRolesByIssuer #### Returns -`Promise`<[`IRole`](../interfaces/IRole.md)[]\> +`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> array of roles that the DID can issue @@ -316,7 +318,7 @@ ___ ### getAppsOfOrg -▸ **getAppsOfOrg**(`org`): `Promise`<[`IApp`](../interfaces/IApp.md)[]\> +▸ **getAppsOfOrg**(`org`): `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> getENSTypesByOwner @@ -330,7 +332,7 @@ getENSTypesByOwner #### Returns -`Promise`<[`IApp`](../interfaces/IApp.md)[]\> +`Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> array of subdomains or empty array when there is no subdomains @@ -370,7 +372,7 @@ ___ | :------ | :------ | | `__namedParameters` | `Object` | | `__namedParameters.namespace` | `string` | -| `__namedParameters.type` | [`NamespaceType`](../enums/NamespaceType.md) | +| `__namedParameters.type` | [`NamespaceType`](../enums/modules_domains.NamespaceType.md) | #### Returns @@ -382,7 +384,7 @@ ___ ### getENSTypesByOwner -▸ **getENSTypesByOwner**(`__namedParameters`): `Promise`<[`IRole`](../interfaces/IRole.md)[]\> \| `Promise`<[`IOrganization`](../interfaces/IOrganization.md)[]\> \| `Promise`<[`IApp`](../interfaces/IApp.md)[]\> +▸ **getENSTypesByOwner**(`__namedParameters`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> \| `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> \| `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> getENSTypesByOwner @@ -392,18 +394,18 @@ getENSTypesByOwner | :------ | :------ | | `__namedParameters` | `Object` | | `__namedParameters.owner` | `string` | -| `__namedParameters.type` | [`NamespaceType`](../enums/NamespaceType.md) | +| `__namedParameters.type` | [`NamespaceType`](../enums/modules_domains.NamespaceType.md) | | `__namedParameters.withRelations?` | `boolean` | #### Returns -`Promise`<[`IRole`](../interfaces/IRole.md)[]\> \| `Promise`<[`IOrganization`](../interfaces/IOrganization.md)[]\> \| `Promise`<[`IApp`](../interfaces/IApp.md)[]\> +`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> \| `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> \| `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\> ___ ### getENSTypesBySearchPhrase -▸ **getENSTypesBySearchPhrase**(`search`, `types?`): `Promise`<([`IRole`](../interfaces/IRole.md) \| [`IOrganization`](../interfaces/IOrganization.md) \| [`IApp`](../interfaces/IApp.md))[]\> +▸ **getENSTypesBySearchPhrase**(`search`, `types?`): `Promise`<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> getENSTypesBySearchPhrase @@ -412,17 +414,17 @@ getENSTypesBySearchPhrase | Name | Type | | :------ | :------ | | `search` | `string` | -| `types?` | [`SearchType`](../enums/SearchType.md)[] | +| `types?` | [`SearchType`](../enums/modules_cacheClient.SearchType.md)[] | #### Returns -`Promise`<([`IRole`](../interfaces/IRole.md) \| [`IOrganization`](../interfaces/IOrganization.md) \| [`IApp`](../interfaces/IApp.md))[]\> +`Promise`<([`IRole`](../interfaces/modules_domains.IRole.md) \| [`IOrganization`](../interfaces/modules_domains.IOrganization.md) \| [`IApp`](../interfaces/modules_domains.IApp.md))[]\> ___ ### getOrgHierarchy -▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](../interfaces/IOrganization.md)\> +▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> getOrgHierarchy @@ -436,7 +438,7 @@ getOrgHierarchy #### Returns -`Promise`<[`IOrganization`](../interfaces/IOrganization.md)\> +`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)\> organization with all nested subOrgs @@ -444,7 +446,7 @@ ___ ### getRolesByNamespace -▸ **getRolesByNamespace**(`__namedParameters`): `Promise`<[`IRole`](../interfaces/IRole.md)[]\> +▸ **getRolesByNamespace**(`__namedParameters`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> getRolesByNamespace @@ -456,11 +458,11 @@ getRolesByNamespace | :------ | :------ | | `__namedParameters` | `Object` | | `__namedParameters.namespace` | `string` | -| `__namedParameters.parentType` | [`Application`](../enums/NamespaceType.md#application) \| [`Organization`](../enums/NamespaceType.md#organization) | +| `__namedParameters.parentType` | [`Application`](../enums/modules_domains.NamespaceType.md#application) \| [`Organization`](../enums/modules_domains.NamespaceType.md#organization) | #### Returns -`Promise`<[`IRole`](../interfaces/IRole.md)[]\> +`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\> array of subdomains or empty array when there is no subdomains @@ -468,7 +470,7 @@ ___ ### getSubOrgsByOrgNamespace -▸ **getSubOrgsByOrgNamespace**(`namespace`): `Promise`<[`IOrganization`](../interfaces/IOrganization.md)[]\> +▸ **getSubOrgsByOrgNamespace**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> getSubOrgsByOrgNamespace @@ -482,7 +484,7 @@ getSubOrgsByOrgNamespace #### Returns -`Promise`<[`IOrganization`](../interfaces/IOrganization.md)[]\> +`Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\> array of subdomains or empty array when there is no subdomains @@ -584,7 +586,7 @@ ___ ### registrationTypesOfRoles -▸ **registrationTypesOfRoles**(`roles`): `Promise`<`Record`<`string`, `Set`<[`RegistrationTypes`](../enums/RegistrationTypes.md)\>\>\> +▸ **registrationTypesOfRoles**(`roles`): `Promise`<`Record`<`string`, `Set`<[`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)\>\>\> #### Parameters @@ -594,7 +596,7 @@ ___ #### Returns -`Promise`<`Record`<`string`, `Set`<[`RegistrationTypes`](../enums/RegistrationTypes.md)\>\>\> +`Promise`<`Record`<`string`, `Set`<[`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)\>\>\> ___ @@ -657,7 +659,7 @@ validateOwnership | :------ | :------ | | `__namedParameters` | `Object` | | `__namedParameters.namespace` | `string` | -| `__namedParameters.type` | [`NamespaceType`](../enums/NamespaceType.md) | +| `__namedParameters.type` | [`NamespaceType`](../enums/modules_domains.NamespaceType.md) | #### Returns @@ -669,15 +671,15 @@ ___ ### create -▸ `Static` **create**(`signerService`, `cacheClient`): `Promise`<[`DomainsService`](DomainsService.md)\> +▸ `Static` **create**(`signerService`, `cacheClient`): `Promise`<[`DomainsService`](modules_domains.DomainsService.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `signerService` | [`SignerService`](SignerService.md) | -| `cacheClient` | [`CacheClient`](CacheClient.md) | +| `signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `cacheClient` | [`CacheClient`](modules_cacheClient.CacheClient.md) | #### Returns -`Promise`<[`DomainsService`](DomainsService.md)\> +`Promise`<[`DomainsService`](modules_domains.DomainsService.md)\> diff --git a/docs/api/classes/MessagingService.md b/docs/api/classes/modules_messaging.MessagingService.md similarity index 61% rename from docs/api/classes/MessagingService.md rename to docs/api/classes/modules_messaging.MessagingService.md index ee5ee0a4..fb5844f3 100644 --- a/docs/api/classes/MessagingService.md +++ b/docs/api/classes/modules_messaging.MessagingService.md @@ -1,18 +1,20 @@ # Class: MessagingService +[modules/messaging](../modules/modules_messaging.md).MessagingService + ## Table of contents ### Constructors -- [constructor](MessagingService.md#constructor) +- [constructor](modules_messaging.MessagingService.md#constructor) ### Methods -- [init](MessagingService.md#init) -- [publish](MessagingService.md#publish) -- [subscribeTo](MessagingService.md#subscribeto) -- [unsubscribeFrom](MessagingService.md#unsubscribefrom) -- [create](MessagingService.md#create) +- [init](modules_messaging.MessagingService.md#init) +- [publish](modules_messaging.MessagingService.md#publish) +- [subscribeTo](modules_messaging.MessagingService.md#subscribeto) +- [unsubscribeFrom](modules_messaging.MessagingService.md#unsubscribefrom) +- [create](modules_messaging.MessagingService.md#create) ## Constructors @@ -24,7 +26,7 @@ | Name | Type | | :------ | :------ | -| `_signerService` | [`SignerService`](SignerService.md) | +| `_signerService` | [`SignerService`](modules_signer.SignerService.md) | ## Methods @@ -65,7 +67,7 @@ ___ | :------ | :------ | | `__namedParameters` | `Object` | | `__namedParameters.subject?` | `string` | -| `__namedParameters.messageHandler` | (`data`: [`IMessage`](../interfaces/IMessage.md)) => `void` | +| `__namedParameters.messageHandler` | (`data`: [`IMessage`](../interfaces/modules_messaging.IMessage.md)) => `void` | #### Returns @@ -91,14 +93,14 @@ ___ ### create -▸ `Static` **create**(`signerService`): `Promise`<[`MessagingService`](MessagingService.md)\> +▸ `Static` **create**(`signerService`): `Promise`<[`MessagingService`](modules_messaging.MessagingService.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `signerService` | [`SignerService`](SignerService.md) | +| `signerService` | [`SignerService`](modules_signer.SignerService.md) | #### Returns -`Promise`<[`MessagingService`](MessagingService.md)\> +`Promise`<[`MessagingService`](modules_messaging.MessagingService.md)\> diff --git a/docs/api/classes/EkcSigner.md b/docs/api/classes/modules_signer.EkcSigner.md similarity index 69% rename from docs/api/classes/EkcSigner.md rename to docs/api/classes/modules_signer.EkcSigner.md index a58b7586..7902d4ca 100644 --- a/docs/api/classes/EkcSigner.md +++ b/docs/api/classes/modules_signer.EkcSigner.md @@ -1,5 +1,7 @@ # Class: EkcSigner +[modules/signer](../modules/modules_signer.md).EkcSigner + ## Hierarchy - `Signer` @@ -14,21 +16,21 @@ ### Constructors -- [constructor](EkcSigner.md#constructor) +- [constructor](modules_signer.EkcSigner.md#constructor) ### Properties -- [ekc](EkcSigner.md#ekc) -- [provider](EkcSigner.md#provider) +- [ekc](modules_signer.EkcSigner.md#ekc) +- [provider](modules_signer.EkcSigner.md#provider) ### Methods -- [\_signTypedData](EkcSigner.md#_signtypeddata) -- [connect](EkcSigner.md#connect) -- [getAddress](EkcSigner.md#getaddress) -- [signMessage](EkcSigner.md#signmessage) -- [signTransaction](EkcSigner.md#signtransaction) -- [create](EkcSigner.md#create) +- [\_signTypedData](modules_signer.EkcSigner.md#_signtypeddata) +- [connect](modules_signer.EkcSigner.md#connect) +- [getAddress](modules_signer.EkcSigner.md#getaddress) +- [signMessage](modules_signer.EkcSigner.md#signmessage) +- [signTransaction](modules_signer.EkcSigner.md#signtransaction) +- [create](modules_signer.EkcSigner.md#create) ## Constructors @@ -154,7 +156,7 @@ ___ ### create -▸ `Static` **create**(`proxyUrl`): `Promise`<[`EkcSigner`](EkcSigner.md)\> +▸ `Static` **create**(`proxyUrl`): `Promise`<[`EkcSigner`](modules_signer.EkcSigner.md)\> #### Parameters @@ -164,4 +166,4 @@ ___ #### Returns -`Promise`<[`EkcSigner`](EkcSigner.md)\> +`Promise`<[`EkcSigner`](modules_signer.EkcSigner.md)\> diff --git a/docs/api/classes/SignerService.md b/docs/api/classes/modules_signer.SignerService.md similarity index 60% rename from docs/api/classes/SignerService.md rename to docs/api/classes/modules_signer.SignerService.md index 71967f78..b7c851bc 100644 --- a/docs/api/classes/SignerService.md +++ b/docs/api/classes/modules_signer.SignerService.md @@ -1,40 +1,42 @@ # Class: SignerService +[modules/signer](../modules/modules_signer.md).SignerService + ## Table of contents ### Constructors -- [constructor](SignerService.md#constructor) +- [constructor](modules_signer.SignerService.md#constructor) ### Accessors -- [accountInfo](SignerService.md#accountinfo) -- [address](SignerService.md#address) -- [chainId](SignerService.md#chainid) -- [did](SignerService.md#did) -- [didHex](SignerService.md#didhex) -- [isEthSigner](SignerService.md#isethsigner) -- [provider](SignerService.md#provider) -- [providerType](SignerService.md#providertype) -- [signer](SignerService.md#signer) +- [accountInfo](modules_signer.SignerService.md#accountinfo) +- [address](modules_signer.SignerService.md#address) +- [chainId](modules_signer.SignerService.md#chainid) +- [did](modules_signer.SignerService.md#did) +- [didHex](modules_signer.SignerService.md#didhex) +- [isEthSigner](modules_signer.SignerService.md#isethsigner) +- [provider](modules_signer.SignerService.md#provider) +- [providerType](modules_signer.SignerService.md#providertype) +- [signer](modules_signer.SignerService.md#signer) ### Methods -- [balance](SignerService.md#balance) -- [call](SignerService.md#call) -- [chainName](SignerService.md#chainname) -- [closeConnection](SignerService.md#closeconnection) -- [connect](SignerService.md#connect) -- [emit](SignerService.md#emit) -- [init](SignerService.md#init) -- [initEventHandlers](SignerService.md#initeventhandlers) -- [on](SignerService.md#on) -- [onInit](SignerService.md#oninit) -- [publicKey](SignerService.md#publickey) -- [publicKeyAndIdentityToken](SignerService.md#publickeyandidentitytoken) -- [send](SignerService.md#send) -- [signMessage](SignerService.md#signmessage) -- [signTypedData](SignerService.md#signtypeddata) +- [balance](modules_signer.SignerService.md#balance) +- [call](modules_signer.SignerService.md#call) +- [chainName](modules_signer.SignerService.md#chainname) +- [closeConnection](modules_signer.SignerService.md#closeconnection) +- [connect](modules_signer.SignerService.md#connect) +- [emit](modules_signer.SignerService.md#emit) +- [init](modules_signer.SignerService.md#init) +- [initEventHandlers](modules_signer.SignerService.md#initeventhandlers) +- [on](modules_signer.SignerService.md#on) +- [onInit](modules_signer.SignerService.md#oninit) +- [publicKey](modules_signer.SignerService.md#publickey) +- [publicKeyAndIdentityToken](modules_signer.SignerService.md#publickeyandidentitytoken) +- [send](modules_signer.SignerService.md#send) +- [signMessage](modules_signer.SignerService.md#signmessage) +- [signTypedData](modules_signer.SignerService.md#signtypeddata) ## Constructors @@ -46,18 +48,18 @@ | Name | Type | | :------ | :------ | -| `_signer` | `Required`<[`SignerT`](../modules.md#signert)\> | -| `_providerType` | [`ProviderType`](../enums/ProviderType.md) | +| `_signer` | `Required`<[`SignerT`](../modules/modules_signer.md#signert)\> | +| `_providerType` | [`ProviderType`](../enums/modules_signer.ProviderType.md) | ## Accessors ### accountInfo -• `get` **accountInfo**(): [`AccountInfo`](../modules.md#accountinfo) +• `get` **accountInfo**(): [`AccountInfo`](../modules/modules_signer.md#accountinfo) #### Returns -[`AccountInfo`](../modules.md#accountinfo) +[`AccountInfo`](../modules/modules_signer.md#accountinfo) ___ @@ -123,21 +125,21 @@ ___ ### providerType -• `get` **providerType**(): [`ProviderType`](../enums/ProviderType.md) +• `get` **providerType**(): [`ProviderType`](../enums/modules_signer.ProviderType.md) #### Returns -[`ProviderType`](../enums/ProviderType.md) +[`ProviderType`](../enums/modules_signer.ProviderType.md) ___ ### signer -• `get` **signer**(): `Required`<[`SignerT`](../modules.md#signert)\> +• `get` **signer**(): `Required`<[`SignerT`](../modules/modules_signer.md#signert)\> #### Returns -`Required`<[`SignerT`](../modules.md#signert)\> +`Required`<[`SignerT`](../modules/modules_signer.md#signert)\> ## Methods @@ -200,8 +202,8 @@ ___ | Name | Type | | :------ | :------ | -| `signer` | `Required`<[`SignerT`](../modules.md#signert)\> | -| `providerType` | [`ProviderType`](../enums/ProviderType.md) | +| `signer` | `Required`<[`SignerT`](../modules/modules_signer.md#signert)\> | +| `providerType` | [`ProviderType`](../enums/modules_signer.ProviderType.md) | #### Returns @@ -217,7 +219,7 @@ ___ | Name | Type | | :------ | :------ | -| `e` | [`ProviderEvent`](../enums/ProviderEvent.md) | +| `e` | [`ProviderEvent`](../enums/modules_signer.ProviderEvent.md) | #### Returns @@ -257,7 +259,7 @@ ___ | Name | Type | | :------ | :------ | -| `event` | [`ProviderEvent`](../enums/ProviderEvent.md) | +| `event` | [`ProviderEvent`](../enums/modules_signer.ProviderEvent.md) | | `cb` | `any` | #### Returns @@ -276,7 +278,7 @@ Registers reinitialization of dependent service on signer reconnection | Name | Type | | :------ | :------ | -| `initializer` | [`ServiceInitializer`](../modules.md#serviceinitializer) | +| `initializer` | [`ServiceInitializer`](../modules/modules_signer.md#serviceinitializer) | #### Returns @@ -296,11 +298,11 @@ ___ ### publicKeyAndIdentityToken -▸ **publicKeyAndIdentityToken**(): `Promise`<[`IPubKeyAndIdentityToken`](../interfaces/IPubKeyAndIdentityToken.md)\> +▸ **publicKeyAndIdentityToken**(): `Promise`<[`IPubKeyAndIdentityToken`](../interfaces/modules_signer.IPubKeyAndIdentityToken.md)\> #### Returns -`Promise`<[`IPubKeyAndIdentityToken`](../interfaces/IPubKeyAndIdentityToken.md)\> +`Promise`<[`IPubKeyAndIdentityToken`](../interfaces/modules_signer.IPubKeyAndIdentityToken.md)\> ___ diff --git a/docs/api/classes/modules_staking.StakingFactoryService.md b/docs/api/classes/modules_staking.StakingFactoryService.md new file mode 100644 index 00000000..4b7e8b36 --- /dev/null +++ b/docs/api/classes/modules_staking.StakingFactoryService.md @@ -0,0 +1,71 @@ +# Class: StakingFactoryService + +[modules/staking](../modules/modules_staking.md).StakingFactoryService + +Intended for staking pool + +## Table of contents + +### Constructors + +- [constructor](modules_staking.StakingFactoryService.md#constructor) + +### Methods + +- [allServices](modules_staking.StakingFactoryService.md#allservices) +- [getPool](modules_staking.StakingFactoryService.md#getpool) +- [create](modules_staking.StakingFactoryService.md#create) + +## Constructors + +### constructor + +• **new StakingFactoryService**(`_signerService`, `_domainsService`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `_domainsService` | [`DomainsService`](modules_domains.DomainsService.md) | + +## Methods + +### allServices + +▸ **allServices**(): `Promise`<[`Service`](../modules/modules_staking.md#service)[]\> + +**`description`** Returns all services for which pools are launched + +#### Returns + +`Promise`<[`Service`](../modules/modules_staking.md#service)[]\> + +___ + +### getPool + +▸ **getPool**(): `Promise`<[`StakingPoolService`](modules_staking.StakingPoolService.md)\> + +**`description`** Returns pool launched for energyweb org + +#### Returns + +`Promise`<[`StakingPoolService`](modules_staking.StakingPoolService.md)\> + +___ + +### create + +▸ `Static` **create**(`signerService`, `domainsService`): `Promise`<[`StakingFactoryService`](modules_staking.StakingFactoryService.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerService` | [`SignerService`](modules_signer.SignerService.md) | +| `domainsService` | [`DomainsService`](modules_domains.DomainsService.md) | + +#### Returns + +`Promise`<[`StakingFactoryService`](modules_staking.StakingFactoryService.md)\> diff --git a/docs/api/classes/StakingPoolService.md b/docs/api/classes/modules_staking.StakingPoolService.md similarity index 62% rename from docs/api/classes/StakingPoolService.md rename to docs/api/classes/modules_staking.StakingPoolService.md index 6f188c3c..930ec37f 100644 --- a/docs/api/classes/StakingPoolService.md +++ b/docs/api/classes/modules_staking.StakingPoolService.md @@ -1,26 +1,28 @@ # Class: StakingPoolService +[modules/staking](../modules/modules_staking.md).StakingPoolService + Abstraction over staking pool smart contract ## Table of contents ### Constructors -- [constructor](StakingPoolService.md#constructor) +- [constructor](modules_staking.StakingPoolService.md#constructor) ### Methods -- [checkReward](StakingPoolService.md#checkreward) -- [getContributionLimit](StakingPoolService.md#getcontributionlimit) -- [getEnd](StakingPoolService.md#getend) -- [getHardCap](StakingPoolService.md#gethardcap) -- [getRatio](StakingPoolService.md#getratio) -- [getStake](StakingPoolService.md#getstake) -- [getStart](StakingPoolService.md#getstart) -- [getTotalStaked](StakingPoolService.md#gettotalstaked) -- [partialWithdraw](StakingPoolService.md#partialwithdraw) -- [putStake](StakingPoolService.md#putstake) -- [withdraw](StakingPoolService.md#withdraw) +- [checkReward](modules_staking.StakingPoolService.md#checkreward) +- [getContributionLimit](modules_staking.StakingPoolService.md#getcontributionlimit) +- [getEnd](modules_staking.StakingPoolService.md#getend) +- [getHardCap](modules_staking.StakingPoolService.md#gethardcap) +- [getRatio](modules_staking.StakingPoolService.md#getratio) +- [getStake](modules_staking.StakingPoolService.md#getstake) +- [getStart](modules_staking.StakingPoolService.md#getstart) +- [getTotalStaked](modules_staking.StakingPoolService.md#gettotalstaked) +- [partialWithdraw](modules_staking.StakingPoolService.md#partialwithdraw) +- [putStake](modules_staking.StakingPoolService.md#putstake) +- [withdraw](modules_staking.StakingPoolService.md#withdraw) ## Constructors @@ -32,7 +34,7 @@ Abstraction over staking pool smart contract | Name | Type | | :------ | :------ | -| `signerService` | [`SignerService`](SignerService.md) | +| `signerService` | [`SignerService`](modules_signer.SignerService.md) | | `address` | `string` | ## Methods @@ -91,11 +93,11 @@ ___ ### getStake -▸ **getStake**(): `Promise`<[`Stake`](../modules.md#stake)\> +▸ **getStake**(): `Promise`<[`Stake`](../modules/modules_staking.md#stake)\> #### Returns -`Promise`<[`Stake`](../modules.md#stake)\> +`Promise`<[`Stake`](../modules/modules_staking.md#stake)\> Stake diff --git a/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md b/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md new file mode 100644 index 00000000..b812e9a2 --- /dev/null +++ b/docs/api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md @@ -0,0 +1,119 @@ +# Class: VerifiableCredentialsServiceBase + +[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).VerifiableCredentialsServiceBase + +## Table of contents + +### Constructors + +- [constructor](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#constructor) + +### Methods + +- [createPresentation](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createpresentation) +- [createRoleVC](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createrolevc) +- [createVerifiablePresentation](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createverifiablepresentation) +- [verify](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#verify) +- [create](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#create) + +## Constructors + +### constructor + +• **new VerifiableCredentialsServiceBase**(`_signerService`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_signerService` | [`SignerService`](modules_signer.SignerService.md) | + +## Methods + +### createPresentation + +▸ **createPresentation**(`verifiableCredential`, `options?`): `Presentation` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `verifiableCredential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>[] | +| `options?` | [`CreatePresentationParams`](../interfaces/modules_verifiable_credentials.CreatePresentationParams.md) | + +#### Returns + +`Presentation` + +___ + +### createRoleVC + +▸ **createRoleVC**(`credentialParams`, `proofOptions?`): `Promise`<`VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `credentialParams` | [`RoleCredentialSubjectParams`](../interfaces/modules_verifiable_credentials.RoleCredentialSubjectParams.md) | +| `proofOptions?` | [`ProofOptions`](../interfaces/modules_verifiable_credentials.ProofOptions.md) | + +#### Returns + +`Promise`<`VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>\> + +___ + +### createVerifiablePresentation + +▸ **createVerifiablePresentation**(`verifiableCredential`, `options?`): `Promise`<`VerifiablePresentation`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `verifiableCredential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\>[] | +| `options?` | [`ProofOptions`](../interfaces/modules_verifiable_credentials.ProofOptions.md) | + +#### Returns + +`Promise`<`VerifiablePresentation`\> + +___ + +### verify + +▸ **verify**<`T`\>(`vp`, `options?`): `any` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `ICredentialSubject` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `vp` | `VerifiablePresentation` \| `VerifiableCredential`<`T`\> | +| `options?` | [`ProofOptions`](../interfaces/modules_verifiable_credentials.ProofOptions.md) | + +#### Returns + +`any` + +___ + +### create + +▸ `Static` **create**(`signerService`): `Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerService` | [`SignerService`](modules_signer.SignerService.md) | + +#### Returns + +`Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> diff --git a/docs/api/enums/ERROR_MESSAGES.md b/docs/api/enums/ERROR_MESSAGES.md deleted file mode 100644 index e8623d65..00000000 --- a/docs/api/enums/ERROR_MESSAGES.md +++ /dev/null @@ -1,202 +0,0 @@ -# Enumeration: ERROR\_MESSAGES - -## Table of contents - -### Enumeration members - -- [APP\_WITH\_ROLES](ERROR_MESSAGES.md#app_with_roles) -- [CAN\_NOT\_UPDATE\_DOCUMENT\_PROPERTIES\_INVALID\_OR\_MISSING](ERROR_MESSAGES.md#can_not_update_document_properties_invalid_or_missing) -- [CAN\_NOT\_UPDATE\_NOT\_CONTROLLED\_DOCUMENT](ERROR_MESSAGES.md#can_not_update_not_controlled_document) -- [CLAIM\_TYPE\_MISSING](ERROR_MESSAGES.md#claim_type_missing) -- [CLAIM\_TYPE\_REQUIRED\_FOR\_ON\_CHAIN\_REGISTRATION](ERROR_MESSAGES.md#claim_type_required_for_on_chain_registration) -- [CLAIM\_WAS\_NOT\_ISSUED](ERROR_MESSAGES.md#claim_was_not_issued) -- [ENS\_OWNER\_NOT\_VALID\_ADDRESS](ERROR_MESSAGES.md#ens_owner_not_valid_address) -- [ENS\_TYPE\_NOT\_SUPPORTED](ERROR_MESSAGES.md#ens_type_not_supported) -- [ERROR\_IN\_AZURE\_PROVIDER](ERROR_MESSAGES.md#error_in_azure_provider) -- [INSUFFICIENT\_BALANCE](ERROR_MESSAGES.md#insufficient_balance) -- [IS\_ETH\_SIGNER\_NOT\_SET](ERROR_MESSAGES.md#is_eth_signer_not_set) -- [JWT\_ALGORITHM\_NOT\_SUPPORTED](ERROR_MESSAGES.md#jwt_algorithm_not_supported) -- [METAMASK\_ACCOUNT\_NOT\_PROVIDED](ERROR_MESSAGES.md#metamask_account_not_provided) -- [METAMASK\_PROVIDER\_NOT\_DETECTED](ERROR_MESSAGES.md#metamask_provider_not_detected) -- [NON\_ETH\_SIGN\_SIGNATURE](ERROR_MESSAGES.md#non_eth_sign_signature) -- [NOT\_AUTHORIZED\_TO\_CHANGE\_DOMAIN](ERROR_MESSAGES.md#not_authorized_to_change_domain) -- [ONCHAIN\_ROLE\_VERSION\_NOT\_SPECIFIED](ERROR_MESSAGES.md#onchain_role_version_not_specified) -- [ORG\_WITH\_APPS](ERROR_MESSAGES.md#org_with_apps) -- [ORG\_WITH\_ROLES](ERROR_MESSAGES.md#org_with_roles) -- [PUBLISH\_NOT\_ISSUED\_CLAIM](ERROR_MESSAGES.md#publish_not_issued_claim) -- [ROLE\_NOT\_EXISTS](ERROR_MESSAGES.md#role_not_exists) -- [ROLE\_PREREQUISITES\_NOT\_MET](ERROR_MESSAGES.md#role_prerequisites_not_met) -- [SIGN\_TYPED\_DATA\_NOT\_SUPPORTED](ERROR_MESSAGES.md#sign_typed_data_not_supported) -- [STAKE\_WAS\_NOT\_PUT](ERROR_MESSAGES.md#stake_was_not_put) -- [TOKEN\_REQUIRED\_FOR\_OFF\_CHAIN\_REGISTRATION](ERROR_MESSAGES.md#token_required_for_off_chain_registration) -- [UNKNOWN\_PROVIDER](ERROR_MESSAGES.md#unknown_provider) -- [WALLET\_PROVIDER\_NOT\_SUPPORTED](ERROR_MESSAGES.md#wallet_provider_not_supported) -- [WITHDRAWAL\_WAS\_NOT\_REQUESTED](ERROR_MESSAGES.md#withdrawal_was_not_requested) - -## Enumeration members - -### APP\_WITH\_ROLES - -• **APP\_WITH\_ROLES** = `"You are not able to remove application with registered roles"` - -___ - -### CAN\_NOT\_UPDATE\_DOCUMENT\_PROPERTIES\_INVALID\_OR\_MISSING - -• **CAN\_NOT\_UPDATE\_DOCUMENT\_PROPERTIES\_INVALID\_OR\_MISSING** = `"Cannot update document. Properties invalid or missing: "` - -___ - -### CAN\_NOT\_UPDATE\_NOT\_CONTROLLED\_DOCUMENT - -• **CAN\_NOT\_UPDATE\_NOT\_CONTROLLED\_DOCUMENT** = `"Can not update not controlled document"` - -___ - -### CLAIM\_TYPE\_MISSING - -• **CLAIM\_TYPE\_MISSING** = `"Claim type is required for On-chain registration"` - -___ - -### CLAIM\_TYPE\_REQUIRED\_FOR\_ON\_CHAIN\_REGISTRATION - -• **CLAIM\_TYPE\_REQUIRED\_FOR\_ON\_CHAIN\_REGISTRATION** = `"claimType required for on-chain registration"` - -___ - -### CLAIM\_WAS\_NOT\_ISSUED - -• **CLAIM\_WAS\_NOT\_ISSUED** = `"Claim was not issued"` - -___ - -### ENS\_OWNER\_NOT\_VALID\_ADDRESS - -• **ENS\_OWNER\_NOT\_VALID\_ADDRESS** = `"Provided owner is not a valid address. Owner of ENS domain must be an address"` - -___ - -### ENS\_TYPE\_NOT\_SUPPORTED - -• **ENS\_TYPE\_NOT\_SUPPORTED** = `"ENS type not supported"` - -___ - -### ERROR\_IN\_AZURE\_PROVIDER - -• **ERROR\_IN\_AZURE\_PROVIDER** = `"Error in Azure Provider"` - -___ - -### INSUFFICIENT\_BALANCE - -• **INSUFFICIENT\_BALANCE** = `"Signer has insufficient balance"` - -___ - -### IS\_ETH\_SIGNER\_NOT\_SET - -• **IS\_ETH\_SIGNER\_NOT\_SET** = `"Can not determine if signer is conformant with eth_sign specification"` - -___ - -### JWT\_ALGORITHM\_NOT\_SUPPORTED - -• **JWT\_ALGORITHM\_NOT\_SUPPORTED** = `"Jwt algorithm not supported"` - -___ - -### METAMASK\_ACCOUNT\_NOT\_PROVIDED - -• **METAMASK\_ACCOUNT\_NOT\_PROVIDED** = `"Metamask account not provided"` - -___ - -### METAMASK\_PROVIDER\_NOT\_DETECTED - -• **METAMASK\_PROVIDER\_NOT\_DETECTED** = `"Metamask provider not detected"` - -___ - -### NON\_ETH\_SIGN\_SIGNATURE - -• **NON\_ETH\_SIGN\_SIGNATURE** = `"Signature is not eth_sign verifiable"` - -___ - -### NOT\_AUTHORIZED\_TO\_CHANGE\_DOMAIN - -• **NOT\_AUTHORIZED\_TO\_CHANGE\_DOMAIN** = `"Not authorized to change domain"` - -___ - -### ONCHAIN\_ROLE\_VERSION\_NOT\_SPECIFIED - -• **ONCHAIN\_ROLE\_VERSION\_NOT\_SPECIFIED** = `"On-chain role version not specified"` - -___ - -### ORG\_WITH\_APPS - -• **ORG\_WITH\_APPS** = `"You are not able to remove organization with registered apps"` - -___ - -### ORG\_WITH\_ROLES - -• **ORG\_WITH\_ROLES** = `"You are not able to remove organization with registered roles"` - -___ - -### PUBLISH\_NOT\_ISSUED\_CLAIM - -• **PUBLISH\_NOT\_ISSUED\_CLAIM** = `"Claim to publish has not been issued"` - -___ - -### ROLE\_NOT\_EXISTS - -• **ROLE\_NOT\_EXISTS** = `"Role you want to enroll to does not exists"` - -___ - -### ROLE\_PREREQUISITES\_NOT\_MET - -• **ROLE\_PREREQUISITES\_NOT\_MET** = `"Enrolment subject doesn't have required roles"` - -___ - -### SIGN\_TYPED\_DATA\_NOT\_SUPPORTED - -• **SIGN\_TYPED\_DATA\_NOT\_SUPPORTED** = `"Sign typed data not supported"` - -___ - -### STAKE\_WAS\_NOT\_PUT - -• **STAKE\_WAS\_NOT\_PUT** = `"Stake was not put"` - -___ - -### TOKEN\_REQUIRED\_FOR\_OFF\_CHAIN\_REGISTRATION - -• **TOKEN\_REQUIRED\_FOR\_OFF\_CHAIN\_REGISTRATION** = `"token required for off-chain registration"` - -___ - -### UNKNOWN\_PROVIDER - -• **UNKNOWN\_PROVIDER** = `"Unknown provider type"` - -___ - -### WALLET\_PROVIDER\_NOT\_SUPPORTED - -• **WALLET\_PROVIDER\_NOT\_SUPPORTED** = `"Wallet provider must be a supported value"` - -___ - -### WITHDRAWAL\_WAS\_NOT\_REQUESTED - -• **WITHDRAWAL\_WAS\_NOT\_REQUESTED** = `"Stake withdrawal was not requested"` diff --git a/docs/api/enums/ExecutionEnvironment.md b/docs/api/enums/ExecutionEnvironment.md deleted file mode 100644 index 271355c4..00000000 --- a/docs/api/enums/ExecutionEnvironment.md +++ /dev/null @@ -1,20 +0,0 @@ -# Enumeration: ExecutionEnvironment - -## Table of contents - -### Enumeration members - -- [BROWSER](ExecutionEnvironment.md#browser) -- [NODE](ExecutionEnvironment.md#node) - -## Enumeration members - -### BROWSER - -• **BROWSER** = `"ExecutionEnvironment:Browser"` - -___ - -### NODE - -• **NODE** = `"ExecutionEnvironment:Node"` diff --git a/docs/api/enums/SearchType.md b/docs/api/enums/SearchType.md deleted file mode 100644 index c4bdaaf4..00000000 --- a/docs/api/enums/SearchType.md +++ /dev/null @@ -1,27 +0,0 @@ -# Enumeration: SearchType - -## Table of contents - -### Enumeration members - -- [App](SearchType.md#app) -- [Org](SearchType.md#org) -- [Role](SearchType.md#role) - -## Enumeration members - -### App - -• **App** = `"App"` - -___ - -### Org - -• **Org** = `"Org"` - -___ - -### Role - -• **Role** = `"Role"` diff --git a/docs/api/enums/StakeStatus.md b/docs/api/enums/StakeStatus.md deleted file mode 100644 index 0d5546a6..00000000 --- a/docs/api/enums/StakeStatus.md +++ /dev/null @@ -1,27 +0,0 @@ -# Enumeration: StakeStatus - -## Table of contents - -### Enumeration members - -- [NONSTAKING](StakeStatus.md#nonstaking) -- [STAKING](StakeStatus.md#staking) -- [WITHDRAWING](StakeStatus.md#withdrawing) - -## Enumeration members - -### NONSTAKING - -• **NONSTAKING** = `0` - -___ - -### STAKING - -• **STAKING** = `1` - -___ - -### WITHDRAWING - -• **WITHDRAWING** = `2` diff --git a/docs/api/enums/AssetHistoryEventType.md b/docs/api/enums/modules_assets.AssetHistoryEventType.md similarity index 51% rename from docs/api/enums/AssetHistoryEventType.md rename to docs/api/enums/modules_assets.AssetHistoryEventType.md index 29a5b570..00381638 100644 --- a/docs/api/enums/AssetHistoryEventType.md +++ b/docs/api/enums/modules_assets.AssetHistoryEventType.md @@ -1,14 +1,16 @@ # Enumeration: AssetHistoryEventType +[modules/assets](../modules/modules_assets.md).AssetHistoryEventType + ## Table of contents ### Enumeration members -- [ASSET\_CREATED](AssetHistoryEventType.md#asset_created) -- [ASSET\_OFFERED](AssetHistoryEventType.md#asset_offered) -- [ASSET\_OFFER\_CANCELED](AssetHistoryEventType.md#asset_offer_canceled) -- [ASSET\_OFFER\_REJECTED](AssetHistoryEventType.md#asset_offer_rejected) -- [ASSET\_TRANSFERRED](AssetHistoryEventType.md#asset_transferred) +- [ASSET\_CREATED](modules_assets.AssetHistoryEventType.md#asset_created) +- [ASSET\_OFFERED](modules_assets.AssetHistoryEventType.md#asset_offered) +- [ASSET\_OFFER\_CANCELED](modules_assets.AssetHistoryEventType.md#asset_offer_canceled) +- [ASSET\_OFFER\_REJECTED](modules_assets.AssetHistoryEventType.md#asset_offer_rejected) +- [ASSET\_TRANSFERRED](modules_assets.AssetHistoryEventType.md#asset_transferred) ## Enumeration members diff --git a/docs/api/enums/Order.md b/docs/api/enums/modules_cacheClient.Order.md similarity index 52% rename from docs/api/enums/Order.md rename to docs/api/enums/modules_cacheClient.Order.md index 99fcf298..cfc37e04 100644 --- a/docs/api/enums/Order.md +++ b/docs/api/enums/modules_cacheClient.Order.md @@ -1,11 +1,13 @@ # Enumeration: Order +[modules/cacheClient](../modules/modules_cacheClient.md).Order + ## Table of contents ### Enumeration members -- [ASC](Order.md#asc) -- [DESC](Order.md#desc) +- [ASC](modules_cacheClient.Order.md#asc) +- [DESC](modules_cacheClient.Order.md#desc) ## Enumeration members diff --git a/docs/api/enums/modules_cacheClient.SearchType.md b/docs/api/enums/modules_cacheClient.SearchType.md new file mode 100644 index 00000000..b8d60301 --- /dev/null +++ b/docs/api/enums/modules_cacheClient.SearchType.md @@ -0,0 +1,29 @@ +# Enumeration: SearchType + +[modules/cacheClient](../modules/modules_cacheClient.md).SearchType + +## Table of contents + +### Enumeration members + +- [App](modules_cacheClient.SearchType.md#app) +- [Org](modules_cacheClient.SearchType.md#org) +- [Role](modules_cacheClient.SearchType.md#role) + +## Enumeration members + +### App + +• **App** = `"App"` + +___ + +### Org + +• **Org** = `"Org"` + +___ + +### Role + +• **Role** = `"Role"` diff --git a/docs/api/enums/ClaimEventType.md b/docs/api/enums/modules_claims.ClaimEventType.md similarity index 54% rename from docs/api/enums/ClaimEventType.md rename to docs/api/enums/modules_claims.ClaimEventType.md index 08d9b6cd..2a9bc95b 100644 --- a/docs/api/enums/ClaimEventType.md +++ b/docs/api/enums/modules_claims.ClaimEventType.md @@ -1,12 +1,14 @@ # Enumeration: ClaimEventType +[modules/claims](../modules/modules_claims.md).ClaimEventType + ## Table of contents ### Enumeration members -- [ISSUE\_CREDENTIAL](ClaimEventType.md#issue_credential) -- [REJECT\_CREDENTIAL](ClaimEventType.md#reject_credential) -- [REQUEST\_CREDENTIALS](ClaimEventType.md#request_credentials) +- [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 diff --git a/docs/api/enums/RegistrationTypes.md b/docs/api/enums/modules_claims.RegistrationTypes.md similarity index 56% rename from docs/api/enums/RegistrationTypes.md rename to docs/api/enums/modules_claims.RegistrationTypes.md index c1c4caf2..68369260 100644 --- a/docs/api/enums/RegistrationTypes.md +++ b/docs/api/enums/modules_claims.RegistrationTypes.md @@ -1,11 +1,13 @@ # Enumeration: RegistrationTypes +[modules/claims](../modules/modules_claims.md).RegistrationTypes + ## Table of contents ### Enumeration members -- [OffChain](RegistrationTypes.md#offchain) -- [OnChain](RegistrationTypes.md#onchain) +- [OffChain](modules_claims.RegistrationTypes.md#offchain) +- [OnChain](modules_claims.RegistrationTypes.md#onchain) ## Enumeration members diff --git a/docs/api/enums/NamespaceType.md b/docs/api/enums/modules_domains.NamespaceType.md similarity index 50% rename from docs/api/enums/NamespaceType.md rename to docs/api/enums/modules_domains.NamespaceType.md index cfa17c47..10ac9243 100644 --- a/docs/api/enums/NamespaceType.md +++ b/docs/api/enums/modules_domains.NamespaceType.md @@ -1,12 +1,14 @@ # Enumeration: NamespaceType +[modules/domains](../modules/modules_domains.md).NamespaceType + ## Table of contents ### Enumeration members -- [Application](NamespaceType.md#application) -- [Organization](NamespaceType.md#organization) -- [Role](NamespaceType.md#role) +- [Application](modules_domains.NamespaceType.md#application) +- [Organization](modules_domains.NamespaceType.md#organization) +- [Role](modules_domains.NamespaceType.md#role) ## Enumeration members diff --git a/docs/api/enums/MessagingMethod.md b/docs/api/enums/modules_messaging.MessagingMethod.md similarity index 53% rename from docs/api/enums/MessagingMethod.md rename to docs/api/enums/modules_messaging.MessagingMethod.md index 8592df37..debea7bb 100644 --- a/docs/api/enums/MessagingMethod.md +++ b/docs/api/enums/modules_messaging.MessagingMethod.md @@ -1,10 +1,12 @@ # Enumeration: MessagingMethod +[modules/messaging](../modules/modules_messaging.md).MessagingMethod + ## Table of contents ### Enumeration members -- [Nats](MessagingMethod.md#nats) +- [Nats](modules_messaging.MessagingMethod.md#nats) ## Enumeration members diff --git a/docs/api/enums/ProviderEvent.md b/docs/api/enums/modules_signer.ProviderEvent.md similarity index 62% rename from docs/api/enums/ProviderEvent.md rename to docs/api/enums/modules_signer.ProviderEvent.md index 905ca95f..33236f16 100644 --- a/docs/api/enums/ProviderEvent.md +++ b/docs/api/enums/modules_signer.ProviderEvent.md @@ -1,13 +1,15 @@ # Enumeration: ProviderEvent +[modules/signer](../modules/modules_signer.md).ProviderEvent + ## Table of contents ### Enumeration members -- [AccountChanged](ProviderEvent.md#accountchanged) -- [Disconnected](ProviderEvent.md#disconnected) -- [NetworkChanged](ProviderEvent.md#networkchanged) -- [SessionUpdate](ProviderEvent.md#sessionupdate) +- [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 diff --git a/docs/api/enums/ProviderType.md b/docs/api/enums/modules_signer.ProviderType.md similarity index 52% rename from docs/api/enums/ProviderType.md rename to docs/api/enums/modules_signer.ProviderType.md index 284feb2e..97e7d1f5 100644 --- a/docs/api/enums/ProviderType.md +++ b/docs/api/enums/modules_signer.ProviderType.md @@ -1,15 +1,17 @@ # Enumeration: ProviderType +[modules/signer](../modules/modules_signer.md).ProviderType + ## Table of contents ### Enumeration members -- [EKC](ProviderType.md#ekc) -- [EwKeyManager](ProviderType.md#ewkeymanager) -- [Gnosis](ProviderType.md#gnosis) -- [MetaMask](ProviderType.md#metamask) -- [PrivateKey](ProviderType.md#privatekey) -- [WalletConnect](ProviderType.md#walletconnect) +- [EKC](modules_signer.ProviderType.md#ekc) +- [EwKeyManager](modules_signer.ProviderType.md#ewkeymanager) +- [Gnosis](modules_signer.ProviderType.md#gnosis) +- [MetaMask](modules_signer.ProviderType.md#metamask) +- [PrivateKey](modules_signer.ProviderType.md#privatekey) +- [WalletConnect](modules_signer.ProviderType.md#walletconnect) ## Enumeration members diff --git a/docs/api/enums/modules_staking.StakeStatus.md b/docs/api/enums/modules_staking.StakeStatus.md new file mode 100644 index 00000000..2221df5f --- /dev/null +++ b/docs/api/enums/modules_staking.StakeStatus.md @@ -0,0 +1,29 @@ +# Enumeration: StakeStatus + +[modules/staking](../modules/modules_staking.md).StakeStatus + +## Table of contents + +### Enumeration members + +- [NONSTAKING](modules_staking.StakeStatus.md#nonstaking) +- [STAKING](modules_staking.StakeStatus.md#staking) +- [WITHDRAWING](modules_staking.StakeStatus.md#withdrawing) + +## Enumeration members + +### NONSTAKING + +• **NONSTAKING** = `0` + +___ + +### STAKING + +• **STAKING** = `1` + +___ + +### WITHDRAWING + +• **WITHDRAWING** = `2` diff --git a/docs/api/interfaces/AssetHistory.md b/docs/api/interfaces/AssetHistory.md deleted file mode 100644 index ee272b41..00000000 --- a/docs/api/interfaces/AssetHistory.md +++ /dev/null @@ -1,48 +0,0 @@ -# Interface: AssetHistory - -## Table of contents - -### Properties - -- [assetId](AssetHistory.md#assetid) -- [at](AssetHistory.md#at) -- [emittedBy](AssetHistory.md#emittedby) -- [id](AssetHistory.md#id) -- [relatedTo](AssetHistory.md#relatedto) -- [timestamp](AssetHistory.md#timestamp) - -## Properties - -### assetId - -• `Optional` **assetId**: `string` - -___ - -### at - -• **at**: `number` - -___ - -### emittedBy - -• **emittedBy**: `string` - -___ - -### id - -• **id**: `number` - -___ - -### relatedTo - -• `Optional` **relatedTo**: `string` - -___ - -### timestamp - -• **timestamp**: `string` diff --git a/docs/api/interfaces/AssetProfiles.md b/docs/api/interfaces/AssetProfiles.md deleted file mode 100644 index 993f04f7..00000000 --- a/docs/api/interfaces/AssetProfiles.md +++ /dev/null @@ -1,5 +0,0 @@ -# Interface: AssetProfiles - -## Indexable - -▪ [key: `string`]: [`AssetProfile`](AssetProfile.md) diff --git a/docs/api/interfaces/CacheServerClientOptions.md b/docs/api/interfaces/CacheServerClientOptions.md deleted file mode 100644 index 12817c17..00000000 --- a/docs/api/interfaces/CacheServerClientOptions.md +++ /dev/null @@ -1,20 +0,0 @@ -# Interface: CacheServerClientOptions - -## Table of contents - -### Properties - -- [cacheServerSupportsAuth](CacheServerClientOptions.md#cacheserversupportsauth) -- [url](CacheServerClientOptions.md#url) - -## Properties - -### cacheServerSupportsAuth - -• `Optional` **cacheServerSupportsAuth**: `boolean` - -___ - -### url - -• **url**: `string` diff --git a/docs/api/interfaces/ChainConfig.md b/docs/api/interfaces/ChainConfig.md deleted file mode 100644 index 2e8ee9af..00000000 --- a/docs/api/interfaces/ChainConfig.md +++ /dev/null @@ -1,90 +0,0 @@ -# Interface: ChainConfig - -## Table of contents - -### Properties - -- [assetManagerAddress](ChainConfig.md#assetmanageraddress) -- [chainDisplayName](ChainConfig.md#chaindisplayname) -- [chainName](ChainConfig.md#chainname) -- [claimManagerAddress](ChainConfig.md#claimmanageraddress) -- [didRegistryAddress](ChainConfig.md#didregistryaddress) -- [domainNotifierAddress](ChainConfig.md#domainnotifieraddress) -- [ensPublicResolverAddress](ChainConfig.md#enspublicresolveraddress) -- [ensRegistryAddress](ChainConfig.md#ensregistryaddress) -- [ensResolverAddress](ChainConfig.md#ensresolveraddress) -- [ensResolverV2Address](ChainConfig.md#ensresolverv2address) -- [rpcUrl](ChainConfig.md#rpcurl) -- [stakingPoolFactoryAddress](ChainConfig.md#stakingpoolfactoryaddress) - -## Properties - -### assetManagerAddress - -• **assetManagerAddress**: `string` - -___ - -### chainDisplayName - -• **chainDisplayName**: `string` - -___ - -### chainName - -• **chainName**: `Chain` - -___ - -### claimManagerAddress - -• **claimManagerAddress**: `string` - -___ - -### didRegistryAddress - -• **didRegistryAddress**: `string` - -___ - -### domainNotifierAddress - -• **domainNotifierAddress**: `string` - -___ - -### ensPublicResolverAddress - -• **ensPublicResolverAddress**: `string` - -___ - -### ensRegistryAddress - -• **ensRegistryAddress**: `string` - -___ - -### ensResolverAddress - -• **ensResolverAddress**: `string` - -___ - -### ensResolverV2Address - -• **ensResolverV2Address**: `string` - -___ - -### rpcUrl - -• **rpcUrl**: `string` - -___ - -### stakingPoolFactoryAddress - -• **stakingPoolFactoryAddress**: `string` diff --git a/docs/api/interfaces/Claim.md b/docs/api/interfaces/Claim.md deleted file mode 100644 index 9123cd4d..00000000 --- a/docs/api/interfaces/Claim.md +++ /dev/null @@ -1,118 +0,0 @@ -# Interface: Claim - -## Table of contents - -### Properties - -- [acceptedBy](Claim.md#acceptedby) -- [claimIssuer](Claim.md#claimissuer) -- [claimType](Claim.md#claimtype) -- [claimTypeVersion](Claim.md#claimtypeversion) -- [id](Claim.md#id) -- [isAccepted](Claim.md#isaccepted) -- [isRejected](Claim.md#isrejected) -- [issuedToken](Claim.md#issuedtoken) -- [namespace](Claim.md#namespace) -- [onChainProof](Claim.md#onchainproof) -- [redirectUri](Claim.md#redirecturi) -- [registrationTypes](Claim.md#registrationtypes) -- [requester](Claim.md#requester) -- [subject](Claim.md#subject) -- [subjectAgreement](Claim.md#subjectagreement) -- [token](Claim.md#token) - -## Properties - -### acceptedBy - -• `Optional` **acceptedBy**: `string` - -___ - -### claimIssuer - -• **claimIssuer**: `string`[] - -___ - -### claimType - -• **claimType**: `string` - -___ - -### claimTypeVersion - -• **claimTypeVersion**: `string` - -___ - -### id - -• **id**: `string` - -___ - -### isAccepted - -• **isAccepted**: `boolean` - -___ - -### isRejected - -• `Optional` **isRejected**: `boolean` - -___ - -### issuedToken - -• `Optional` **issuedToken**: `string` - -___ - -### namespace - -• **namespace**: `string` - -___ - -### onChainProof - -• `Optional` **onChainProof**: `string` - -___ - -### redirectUri - -• `Optional` **redirectUri**: `string` - -___ - -### registrationTypes - -• **registrationTypes**: [`RegistrationTypes`](../enums/RegistrationTypes.md)[] - -___ - -### requester - -• **requester**: `string` - -___ - -### subject - -• **subject**: `string` - -___ - -### subjectAgreement - -• `Optional` **subjectAgreement**: `string` - -___ - -### token - -• **token**: `string` diff --git a/docs/api/interfaces/CreatePresentationParams.md b/docs/api/interfaces/CreatePresentationParams.md deleted file mode 100644 index 802b72c9..00000000 --- a/docs/api/interfaces/CreatePresentationParams.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: CreatePresentationParams - -## Table of contents - -### Properties - -- [presentationDefinition](CreatePresentationParams.md#presentationdefinition) - -## Properties - -### presentationDefinition - -• `Optional` **presentationDefinition**: `IPresentationDefinition` diff --git a/docs/api/interfaces/IApp.md b/docs/api/interfaces/IApp.md deleted file mode 100644 index 2670fc69..00000000 --- a/docs/api/interfaces/IApp.md +++ /dev/null @@ -1,55 +0,0 @@ -# Interface: IApp - -## Table of contents - -### Properties - -- [definition](IApp.md#definition) -- [id](IApp.md#id) -- [isOwnedByCurrentUser](IApp.md#isownedbycurrentuser) -- [name](IApp.md#name) -- [namespace](IApp.md#namespace) -- [owner](IApp.md#owner) -- [roles](IApp.md#roles) - -## Properties - -### definition - -• **definition**: `IAppDefinition` - -___ - -### id - -• **id**: `number` - -___ - -### isOwnedByCurrentUser - -• `Optional` **isOwnedByCurrentUser**: `boolean` - -___ - -### name - -• **name**: `string` - -___ - -### namespace - -• **namespace**: `string` - -___ - -### owner - -• **owner**: `string` - -___ - -### roles - -• `Optional` **roles**: [`IRole`](IRole.md)[] diff --git a/docs/api/interfaces/IClaimIssuance.md b/docs/api/interfaces/IClaimIssuance.md deleted file mode 100644 index cf00f1c3..00000000 --- a/docs/api/interfaces/IClaimIssuance.md +++ /dev/null @@ -1,87 +0,0 @@ -# Interface: IClaimIssuance - -## Hierarchy - -- [`IMessage`](IMessage.md) - - ↳ **`IClaimIssuance`** - -## Table of contents - -### Properties - -- [acceptedBy](IClaimIssuance.md#acceptedby) -- [claimIssuer](IClaimIssuance.md#claimissuer) -- [claimType](IClaimIssuance.md#claimtype) -- [claimTypeVersion](IClaimIssuance.md#claimtypeversion) -- [id](IClaimIssuance.md#id) -- [issuedToken](IClaimIssuance.md#issuedtoken) -- [onChainProof](IClaimIssuance.md#onchainproof) -- [requester](IClaimIssuance.md#requester) -- [vp](IClaimIssuance.md#vp) - -## Properties - -### acceptedBy - -• **acceptedBy**: `string` - -___ - -### claimIssuer - -• `Optional` **claimIssuer**: `string`[] - -#### Inherited from - -[IMessage](IMessage.md).[claimIssuer](IMessage.md#claimissuer) - -___ - -### claimType - -• `Optional` **claimType**: `string` - -___ - -### claimTypeVersion - -• `Optional` **claimTypeVersion**: `string` - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[IMessage](IMessage.md).[id](IMessage.md#id) - -___ - -### issuedToken - -• `Optional` **issuedToken**: `string` - -___ - -### onChainProof - -• `Optional` **onChainProof**: `string` - -___ - -### requester - -• **requester**: `string` - -#### Inherited from - -[IMessage](IMessage.md).[requester](IMessage.md#requester) - -___ - -### vp - -• `Optional` **vp**: `string` diff --git a/docs/api/interfaces/IClaimRejection.md b/docs/api/interfaces/IClaimRejection.md deleted file mode 100644 index c9830926..00000000 --- a/docs/api/interfaces/IClaimRejection.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: IClaimRejection - -## Hierarchy - -- [`IMessage`](IMessage.md) - - ↳ **`IClaimRejection`** - -## Table of contents - -### Properties - -- [claimIssuer](IClaimRejection.md#claimissuer) -- [id](IClaimRejection.md#id) -- [isRejected](IClaimRejection.md#isrejected) -- [rejectionReason](IClaimRejection.md#rejectionreason) -- [requester](IClaimRejection.md#requester) - -## Properties - -### claimIssuer - -• `Optional` **claimIssuer**: `string`[] - -#### Inherited from - -[IMessage](IMessage.md).[claimIssuer](IMessage.md#claimissuer) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[IMessage](IMessage.md).[id](IMessage.md#id) - -___ - -### isRejected - -• **isRejected**: `boolean` - -___ - -### rejectionReason - -• `Optional` **rejectionReason**: `string` - -___ - -### requester - -• **requester**: `string` - -#### Inherited from - -[IMessage](IMessage.md).[requester](IMessage.md#requester) diff --git a/docs/api/interfaces/IClaimRequest.md b/docs/api/interfaces/IClaimRequest.md deleted file mode 100644 index bb5b6c12..00000000 --- a/docs/api/interfaces/IClaimRequest.md +++ /dev/null @@ -1,80 +0,0 @@ -# Interface: IClaimRequest - -## Hierarchy - -- [`IMessage`](IMessage.md) - - ↳ **`IClaimRequest`** - -## Table of contents - -### Properties - -- [claimIssuer](IClaimRequest.md#claimissuer) -- [claimType](IClaimRequest.md#claimtype) -- [claimTypeVersion](IClaimRequest.md#claimtypeversion) -- [id](IClaimRequest.md#id) -- [registrationTypes](IClaimRequest.md#registrationtypes) -- [requester](IClaimRequest.md#requester) -- [subjectAgreement](IClaimRequest.md#subjectagreement) -- [token](IClaimRequest.md#token) - -## Properties - -### claimIssuer - -• `Optional` **claimIssuer**: `string`[] - -#### Inherited from - -[IMessage](IMessage.md).[claimIssuer](IMessage.md#claimissuer) - -___ - -### claimType - -• **claimType**: `string` - -___ - -### claimTypeVersion - -• **claimTypeVersion**: `string` - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[IMessage](IMessage.md).[id](IMessage.md#id) - -___ - -### registrationTypes - -• **registrationTypes**: [`RegistrationTypes`](../enums/RegistrationTypes.md)[] - -___ - -### requester - -• **requester**: `string` - -#### Inherited from - -[IMessage](IMessage.md).[requester](IMessage.md#requester) - -___ - -### subjectAgreement - -• `Optional` **subjectAgreement**: `string` - -___ - -### token - -• **token**: `string` diff --git a/docs/api/interfaces/IMessage.md b/docs/api/interfaces/IMessage.md deleted file mode 100644 index 87e6b648..00000000 --- a/docs/api/interfaces/IMessage.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: IMessage - -## Hierarchy - -- **`IMessage`** - - ↳ [`IClaimRequest`](IClaimRequest.md) - - ↳ [`IClaimIssuance`](IClaimIssuance.md) - - ↳ [`IClaimRejection`](IClaimRejection.md) - -## Table of contents - -### Properties - -- [claimIssuer](IMessage.md#claimissuer) -- [id](IMessage.md#id) -- [requester](IMessage.md#requester) - -## Properties - -### claimIssuer - -• `Optional` **claimIssuer**: `string`[] - -___ - -### id - -• **id**: `string` - -___ - -### requester - -• **requester**: `string` diff --git a/docs/api/interfaces/IOrganization.md b/docs/api/interfaces/IOrganization.md deleted file mode 100644 index 8e5b0eeb..00000000 --- a/docs/api/interfaces/IOrganization.md +++ /dev/null @@ -1,69 +0,0 @@ -# Interface: IOrganization - -## Table of contents - -### Properties - -- [apps](IOrganization.md#apps) -- [definition](IOrganization.md#definition) -- [id](IOrganization.md#id) -- [isOwnedByCurrentUser](IOrganization.md#isownedbycurrentuser) -- [name](IOrganization.md#name) -- [namespace](IOrganization.md#namespace) -- [owner](IOrganization.md#owner) -- [roles](IOrganization.md#roles) -- [subOrgs](IOrganization.md#suborgs) - -## Properties - -### apps - -• `Optional` **apps**: [`IApp`](IApp.md)[] - -___ - -### definition - -• **definition**: `IOrganizationDefinition` - -___ - -### id - -• **id**: `number` - -___ - -### isOwnedByCurrentUser - -• `Optional` **isOwnedByCurrentUser**: `boolean` - -___ - -### name - -• **name**: `string` - -___ - -### namespace - -• **namespace**: `string` - -___ - -### owner - -• **owner**: `string` - -___ - -### roles - -• `Optional` **roles**: [`IRole`](IRole.md)[] - -___ - -### subOrgs - -• `Optional` **subOrgs**: [`IOrganization`](IOrganization.md)[] diff --git a/docs/api/interfaces/IPubKeyAndIdentityToken.md b/docs/api/interfaces/IPubKeyAndIdentityToken.md deleted file mode 100644 index 16a69f80..00000000 --- a/docs/api/interfaces/IPubKeyAndIdentityToken.md +++ /dev/null @@ -1,20 +0,0 @@ -# Interface: IPubKeyAndIdentityToken - -## Table of contents - -### Properties - -- [identityToken](IPubKeyAndIdentityToken.md#identitytoken) -- [publicKey](IPubKeyAndIdentityToken.md#publickey) - -## Properties - -### identityToken - -• **identityToken**: `string` - -___ - -### publicKey - -• **publicKey**: `string` diff --git a/docs/api/interfaces/IssuerFields.md b/docs/api/interfaces/IssuerFields.md deleted file mode 100644 index b1e56506..00000000 --- a/docs/api/interfaces/IssuerFields.md +++ /dev/null @@ -1,20 +0,0 @@ -# Interface: IssuerFields - -## Table of contents - -### Properties - -- [key](IssuerFields.md#key) -- [value](IssuerFields.md#value) - -## Properties - -### key - -• **key**: `string` - -___ - -### value - -• **value**: `string` \| `number` diff --git a/docs/api/interfaces/MessagingConfig.md b/docs/api/interfaces/MessagingConfig.md deleted file mode 100644 index 596d428d..00000000 --- a/docs/api/interfaces/MessagingConfig.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: MessagingConfig - -## Table of contents - -### Properties - -- [messagingMethod](MessagingConfig.md#messagingmethod) -- [natsEnvironmentName](MessagingConfig.md#natsenvironmentname) -- [natsServerUrl](MessagingConfig.md#natsserverurl) - -## Properties - -### messagingMethod - -• **messagingMethod**: [`Nats`](../enums/MessagingMethod.md#nats) - -___ - -### natsEnvironmentName - -• **natsEnvironmentName**: `string` - -___ - -### natsServerUrl - -• **natsServerUrl**: `string` diff --git a/docs/api/interfaces/Profile.md b/docs/api/interfaces/Profile.md deleted file mode 100644 index 355b850d..00000000 --- a/docs/api/interfaces/Profile.md +++ /dev/null @@ -1,34 +0,0 @@ -# Interface: Profile - -## Table of contents - -### Properties - -- [address](Profile.md#address) -- [assetProfiles](Profile.md#assetprofiles) -- [birthdate](Profile.md#birthdate) -- [name](Profile.md#name) - -## Properties - -### address - -• `Optional` **address**: `string` - -___ - -### assetProfiles - -• `Optional` **assetProfiles**: [`AssetProfiles`](AssetProfiles.md) - -___ - -### birthdate - -• `Optional` **birthdate**: `string` - -___ - -### name - -• `Optional` **name**: `string` diff --git a/docs/api/interfaces/ProofOptions.md b/docs/api/interfaces/ProofOptions.md deleted file mode 100644 index 5f0f429b..00000000 --- a/docs/api/interfaces/ProofOptions.md +++ /dev/null @@ -1,20 +0,0 @@ -# Interface: ProofOptions - -## Table of contents - -### Properties - -- [proofPurpose](ProofOptions.md#proofpurpose) -- [verificationMethod](ProofOptions.md#verificationmethod) - -## Properties - -### proofPurpose - -• `Optional` **proofPurpose**: `string` - -___ - -### verificationMethod - -• `Optional` **verificationMethod**: `string` diff --git a/docs/api/interfaces/RoleCredentialSubject.md b/docs/api/interfaces/RoleCredentialSubject.md deleted file mode 100644 index ac0e1917..00000000 --- a/docs/api/interfaces/RoleCredentialSubject.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: RoleCredentialSubject - -## Hierarchy - -- `CredentialSubject` - - ↳ **`RoleCredentialSubject`** - -## Table of contents - -### Properties - -- [id](RoleCredentialSubject.md#id) -- [issuerFields](RoleCredentialSubject.md#issuerfields) -- [role](RoleCredentialSubject.md#role) - -## Properties - -### id - -• **id**: `string` - -#### Overrides - -CredentialSubject.id - -___ - -### issuerFields - -• **issuerFields**: [`IssuerFields`](IssuerFields.md)[] - -___ - -### role - -• **role**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `namespace` | `string` | -| `version` | `string` | diff --git a/docs/api/interfaces/RoleCredentialSubjectParams.md b/docs/api/interfaces/RoleCredentialSubjectParams.md deleted file mode 100644 index b94c079c..00000000 --- a/docs/api/interfaces/RoleCredentialSubjectParams.md +++ /dev/null @@ -1,34 +0,0 @@ -# Interface: RoleCredentialSubjectParams - -## Table of contents - -### Properties - -- [id](RoleCredentialSubjectParams.md#id) -- [issuerFields](RoleCredentialSubjectParams.md#issuerfields) -- [namespace](RoleCredentialSubjectParams.md#namespace) -- [version](RoleCredentialSubjectParams.md#version) - -## Properties - -### id - -• **id**: `string` - -___ - -### issuerFields - -• `Optional` **issuerFields**: [`IssuerFields`](IssuerFields.md)[] - -___ - -### namespace - -• **namespace**: `string` - -___ - -### version - -• **version**: `string` diff --git a/docs/api/interfaces/VerifyVerifiableCredentialResults.md b/docs/api/interfaces/VerifyVerifiableCredentialResults.md deleted file mode 100644 index 3954a7a6..00000000 --- a/docs/api/interfaces/VerifyVerifiableCredentialResults.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: VerifyVerifiableCredentialResults - -## Table of contents - -### Properties - -- [checks](VerifyVerifiableCredentialResults.md#checks) -- [errors](VerifyVerifiableCredentialResults.md#errors) -- [warnings](VerifyVerifiableCredentialResults.md#warnings) - -## Properties - -### checks - -• **checks**: `string`[] - -___ - -### errors - -• **errors**: `string`[] - -___ - -### warnings - -• **warnings**: `string`[] diff --git a/docs/api/interfaces/Asset.md b/docs/api/interfaces/modules_assets.Asset.md similarity index 52% rename from docs/api/interfaces/Asset.md rename to docs/api/interfaces/modules_assets.Asset.md index 0bb08cea..56ccbe4e 100644 --- a/docs/api/interfaces/Asset.md +++ b/docs/api/interfaces/modules_assets.Asset.md @@ -1,15 +1,17 @@ # Interface: Asset +[modules/assets](../modules/modules_assets.md).Asset + ## Table of contents ### Properties -- [createdAt](Asset.md#createdat) -- [document](Asset.md#document) -- [id](Asset.md#id) -- [offeredTo](Asset.md#offeredto) -- [owner](Asset.md#owner) -- [updatedAt](Asset.md#updatedat) +- [createdAt](modules_assets.Asset.md#createdat) +- [document](modules_assets.Asset.md#document) +- [id](modules_assets.Asset.md#id) +- [offeredTo](modules_assets.Asset.md#offeredto) +- [owner](modules_assets.Asset.md#owner) +- [updatedAt](modules_assets.Asset.md#updatedat) ## Properties diff --git a/docs/api/interfaces/modules_assets.AssetHistory.md b/docs/api/interfaces/modules_assets.AssetHistory.md new file mode 100644 index 00000000..d935cfbd --- /dev/null +++ b/docs/api/interfaces/modules_assets.AssetHistory.md @@ -0,0 +1,50 @@ +# Interface: AssetHistory + +[modules/assets](../modules/modules_assets.md).AssetHistory + +## Table of contents + +### Properties + +- [assetId](modules_assets.AssetHistory.md#assetid) +- [at](modules_assets.AssetHistory.md#at) +- [emittedBy](modules_assets.AssetHistory.md#emittedby) +- [id](modules_assets.AssetHistory.md#id) +- [relatedTo](modules_assets.AssetHistory.md#relatedto) +- [timestamp](modules_assets.AssetHistory.md#timestamp) + +## Properties + +### assetId + +• `Optional` **assetId**: `string` + +___ + +### at + +• **at**: `number` + +___ + +### emittedBy + +• **emittedBy**: `string` + +___ + +### id + +• **id**: `number` + +___ + +### relatedTo + +• `Optional` **relatedTo**: `string` + +___ + +### timestamp + +• **timestamp**: `string` diff --git a/docs/api/interfaces/modules_cacheClient.CacheServerClientOptions.md b/docs/api/interfaces/modules_cacheClient.CacheServerClientOptions.md new file mode 100644 index 00000000..acb343c4 --- /dev/null +++ b/docs/api/interfaces/modules_cacheClient.CacheServerClientOptions.md @@ -0,0 +1,22 @@ +# Interface: CacheServerClientOptions + +[modules/cacheClient](../modules/modules_cacheClient.md).CacheServerClientOptions + +## Table of contents + +### Properties + +- [cacheServerSupportsAuth](modules_cacheClient.CacheServerClientOptions.md#cacheserversupportsauth) +- [url](modules_cacheClient.CacheServerClientOptions.md#url) + +## Properties + +### cacheServerSupportsAuth + +• `Optional` **cacheServerSupportsAuth**: `boolean` + +___ + +### url + +• **url**: `string` diff --git a/docs/api/interfaces/ICacheClient.md b/docs/api/interfaces/modules_cacheClient.ICacheClient.md similarity index 50% rename from docs/api/interfaces/ICacheClient.md rename to docs/api/interfaces/modules_cacheClient.ICacheClient.md index 7a280a47..fbd92f92 100644 --- a/docs/api/interfaces/ICacheClient.md +++ b/docs/api/interfaces/modules_cacheClient.ICacheClient.md @@ -1,55 +1,57 @@ # Interface: ICacheClient +[modules/cacheClient](../modules/modules_cacheClient.md).ICacheClient + ## Implemented by -- [`CacheClient`](../classes/CacheClient.md) +- [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ## Table of contents ### Properties -- [pubKeyAndIdentityToken](ICacheClient.md#pubkeyandidentitytoken) +- [pubKeyAndIdentityToken](modules_cacheClient.ICacheClient.md#pubkeyandidentitytoken) ### Methods -- [addDIDToWatchList](ICacheClient.md#adddidtowatchlist) -- [deleteClaim](ICacheClient.md#deleteclaim) -- [getAppDefinition](ICacheClient.md#getappdefinition) -- [getApplicationRoles](ICacheClient.md#getapplicationroles) -- [getApplicationsByOrganization](ICacheClient.md#getapplicationsbyorganization) -- [getApplicationsByOwner](ICacheClient.md#getapplicationsbyowner) -- [getAssetById](ICacheClient.md#getassetbyid) -- [getAssetHistory](ICacheClient.md#getassethistory) -- [getClaimById](ICacheClient.md#getclaimbyid) -- [getClaimsByIssuer](ICacheClient.md#getclaimsbyissuer) -- [getClaimsByRequester](ICacheClient.md#getclaimsbyrequester) -- [getClaimsBySubject](ICacheClient.md#getclaimsbysubject) -- [getClaimsBySubjects](ICacheClient.md#getclaimsbysubjects) -- [getDIDsForRole](ICacheClient.md#getdidsforrole) -- [getDidDocument](ICacheClient.md#getdiddocument) -- [getNamespaceBySearchPhrase](ICacheClient.md#getnamespacebysearchphrase) -- [getOfferedAssets](ICacheClient.md#getofferedassets) -- [getOrgDefinition](ICacheClient.md#getorgdefinition) -- [getOrgHierarchy](ICacheClient.md#getorghierarchy) -- [getOrganizationRoles](ICacheClient.md#getorganizationroles) -- [getOrganizationsByOwner](ICacheClient.md#getorganizationsbyowner) -- [getOwnedAssets](ICacheClient.md#getownedassets) -- [getPreviouslyOwnedAssets](ICacheClient.md#getpreviouslyownedassets) -- [getRoleDefinition](ICacheClient.md#getroledefinition) -- [getRolesByOwner](ICacheClient.md#getrolesbyowner) -- [getRolesDefinition](ICacheClient.md#getrolesdefinition) -- [getSubOrganizationsByOrganization](ICacheClient.md#getsuborganizationsbyorganization) -- [isAuthEnabled](ICacheClient.md#isauthenabled) -- [issueClaim](ICacheClient.md#issueclaim) -- [login](ICacheClient.md#login) -- [rejectClaim](ICacheClient.md#rejectclaim) -- [requestClaim](ICacheClient.md#requestclaim) +- [addDIDToWatchList](modules_cacheClient.ICacheClient.md#adddidtowatchlist) +- [deleteClaim](modules_cacheClient.ICacheClient.md#deleteclaim) +- [getAppDefinition](modules_cacheClient.ICacheClient.md#getappdefinition) +- [getApplicationRoles](modules_cacheClient.ICacheClient.md#getapplicationroles) +- [getApplicationsByOrganization](modules_cacheClient.ICacheClient.md#getapplicationsbyorganization) +- [getApplicationsByOwner](modules_cacheClient.ICacheClient.md#getapplicationsbyowner) +- [getAssetById](modules_cacheClient.ICacheClient.md#getassetbyid) +- [getAssetHistory](modules_cacheClient.ICacheClient.md#getassethistory) +- [getClaimById](modules_cacheClient.ICacheClient.md#getclaimbyid) +- [getClaimsByIssuer](modules_cacheClient.ICacheClient.md#getclaimsbyissuer) +- [getClaimsByRequester](modules_cacheClient.ICacheClient.md#getclaimsbyrequester) +- [getClaimsBySubject](modules_cacheClient.ICacheClient.md#getclaimsbysubject) +- [getClaimsBySubjects](modules_cacheClient.ICacheClient.md#getclaimsbysubjects) +- [getDIDsForRole](modules_cacheClient.ICacheClient.md#getdidsforrole) +- [getDidDocument](modules_cacheClient.ICacheClient.md#getdiddocument) +- [getNamespaceBySearchPhrase](modules_cacheClient.ICacheClient.md#getnamespacebysearchphrase) +- [getOfferedAssets](modules_cacheClient.ICacheClient.md#getofferedassets) +- [getOrgDefinition](modules_cacheClient.ICacheClient.md#getorgdefinition) +- [getOrgHierarchy](modules_cacheClient.ICacheClient.md#getorghierarchy) +- [getOrganizationRoles](modules_cacheClient.ICacheClient.md#getorganizationroles) +- [getOrganizationsByOwner](modules_cacheClient.ICacheClient.md#getorganizationsbyowner) +- [getOwnedAssets](modules_cacheClient.ICacheClient.md#getownedassets) +- [getPreviouslyOwnedAssets](modules_cacheClient.ICacheClient.md#getpreviouslyownedassets) +- [getRoleDefinition](modules_cacheClient.ICacheClient.md#getroledefinition) +- [getRolesByOwner](modules_cacheClient.ICacheClient.md#getrolesbyowner) +- [getRolesDefinition](modules_cacheClient.ICacheClient.md#getrolesdefinition) +- [getSubOrganizationsByOrganization](modules_cacheClient.ICacheClient.md#getsuborganizationsbyorganization) +- [isAuthEnabled](modules_cacheClient.ICacheClient.md#isauthenabled) +- [issueClaim](modules_cacheClient.ICacheClient.md#issueclaim) +- [login](modules_cacheClient.ICacheClient.md#login) +- [rejectClaim](modules_cacheClient.ICacheClient.md#rejectclaim) +- [requestClaim](modules_cacheClient.ICacheClient.md#requestclaim) ## Properties ### pubKeyAndIdentityToken -• **pubKeyAndIdentityToken**: `undefined` \| [`IPubKeyAndIdentityToken`](IPubKeyAndIdentityToken.md) +• **pubKeyAndIdentityToken**: `undefined` \| [`IPubKeyAndIdentityToken`](modules_signer.IPubKeyAndIdentityToken.md) ## Methods @@ -103,7 +105,7 @@ ___ ### getApplicationRoles -▸ **getApplicationRoles**(`namespace`): `Promise`<[`IRole`](IRole.md)[]\> +▸ **getApplicationRoles**(`namespace`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> #### Parameters @@ -113,13 +115,13 @@ ___ #### Returns -`Promise`<[`IRole`](IRole.md)[]\> +`Promise`<[`IRole`](modules_domains.IRole.md)[]\> ___ ### getApplicationsByOrganization -▸ **getApplicationsByOrganization**(`namespace`): `Promise`<[`IApp`](IApp.md)[]\> +▸ **getApplicationsByOrganization**(`namespace`): `Promise`<[`IApp`](modules_domains.IApp.md)[]\> #### Parameters @@ -129,13 +131,13 @@ ___ #### Returns -`Promise`<[`IApp`](IApp.md)[]\> +`Promise`<[`IApp`](modules_domains.IApp.md)[]\> ___ ### getApplicationsByOwner -▸ **getApplicationsByOwner**(`owner`): `Promise`<[`IApp`](IApp.md)[]\> +▸ **getApplicationsByOwner**(`owner`): `Promise`<[`IApp`](modules_domains.IApp.md)[]\> #### Parameters @@ -145,13 +147,13 @@ ___ #### Returns -`Promise`<[`IApp`](IApp.md)[]\> +`Promise`<[`IApp`](modules_domains.IApp.md)[]\> ___ ### getAssetById -▸ **getAssetById**(`id`): `Promise`<[`Asset`](Asset.md)\> +▸ **getAssetById**(`id`): `Promise`<[`Asset`](modules_assets.Asset.md)\> #### Parameters @@ -161,30 +163,30 @@ ___ #### Returns -`Promise`<[`Asset`](Asset.md)\> +`Promise`<[`Asset`](modules_assets.Asset.md)\> ___ ### getAssetHistory -▸ **getAssetHistory**(`id`, `filter?`): `Promise`<[`AssetHistory`](AssetHistory.md)[]\> +▸ **getAssetHistory**(`id`, `filter?`): `Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `filter?` | [`AssetsFilter`](../modules.md#assetsfilter) | +| `filter?` | [`AssetsFilter`](../modules/modules_cacheClient.md#assetsfilter) | #### Returns -`Promise`<[`AssetHistory`](AssetHistory.md)[]\> +`Promise`<[`AssetHistory`](modules_assets.AssetHistory.md)[]\> ___ ### getClaimById -▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](Claim.md)\> +▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> #### Parameters @@ -194,64 +196,64 @@ ___ #### Returns -`Promise`<`undefined` \| [`Claim`](Claim.md)\> +`Promise`<`undefined` \| [`Claim`](modules_claims.Claim.md)\> ___ ### getClaimsByIssuer -▸ **getClaimsByIssuer**(`issuer`, `filter?`): `Promise`<[`Claim`](Claim.md)[]\> +▸ **getClaimsByIssuer**(`issuer`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> #### Parameters | Name | Type | | :------ | :------ | | `issuer` | `string` | -| `filter?` | [`ClaimsFilter`](../modules.md#claimsfilter) | +| `filter?` | [`ClaimsFilter`](../modules/modules_cacheClient.md#claimsfilter) | #### Returns -`Promise`<[`Claim`](Claim.md)[]\> +`Promise`<[`Claim`](modules_claims.Claim.md)[]\> ___ ### getClaimsByRequester -▸ **getClaimsByRequester**(`requester`, `filter?`): `Promise`<[`Claim`](Claim.md)[]\> +▸ **getClaimsByRequester**(`requester`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> #### Parameters | Name | Type | | :------ | :------ | | `requester` | `string` | -| `filter?` | [`ClaimsFilter`](../modules.md#claimsfilter) | +| `filter?` | [`ClaimsFilter`](../modules/modules_cacheClient.md#claimsfilter) | #### Returns -`Promise`<[`Claim`](Claim.md)[]\> +`Promise`<[`Claim`](modules_claims.Claim.md)[]\> ___ ### getClaimsBySubject -▸ **getClaimsBySubject**(`subject`, `filter?`): `Promise`<[`Claim`](Claim.md)[]\> +▸ **getClaimsBySubject**(`subject`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> #### Parameters | Name | Type | | :------ | :------ | | `subject` | `string` | -| `filter?` | [`ClaimsFilter`](../modules.md#claimsfilter) | +| `filter?` | [`ClaimsFilter`](../modules/modules_cacheClient.md#claimsfilter) | #### Returns -`Promise`<[`Claim`](Claim.md)[]\> +`Promise`<[`Claim`](modules_claims.Claim.md)[]\> ___ ### getClaimsBySubjects -▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](Claim.md)[]\> +▸ **getClaimsBySubjects**(`subjects`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\> #### Parameters @@ -261,7 +263,7 @@ ___ #### Returns -`Promise`<[`Claim`](Claim.md)[]\> +`Promise`<[`Claim`](modules_claims.Claim.md)[]\> ___ @@ -300,24 +302,24 @@ ___ ### getNamespaceBySearchPhrase -▸ **getNamespaceBySearchPhrase**(`phrase`, `types?`): `Promise`<([`IRole`](IRole.md) \| [`IOrganization`](IOrganization.md) \| [`IApp`](IApp.md))[]\> +▸ **getNamespaceBySearchPhrase**(`phrase`, `types?`): `Promise`<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> #### Parameters | Name | Type | | :------ | :------ | | `phrase` | `string` | -| `types?` | [`SearchType`](../enums/SearchType.md)[] | +| `types?` | [`SearchType`](../enums/modules_cacheClient.SearchType.md)[] | #### Returns -`Promise`<([`IRole`](IRole.md) \| [`IOrganization`](IOrganization.md) \| [`IApp`](IApp.md))[]\> +`Promise`<([`IRole`](modules_domains.IRole.md) \| [`IOrganization`](modules_domains.IOrganization.md) \| [`IApp`](modules_domains.IApp.md))[]\> ___ ### getOfferedAssets -▸ **getOfferedAssets**(`offeredTo`): `Promise`<[`Asset`](Asset.md)[]\> +▸ **getOfferedAssets**(`offeredTo`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> #### Parameters @@ -327,7 +329,7 @@ ___ #### Returns -`Promise`<[`Asset`](Asset.md)[]\> +`Promise`<[`Asset`](modules_assets.Asset.md)[]\> ___ @@ -349,7 +351,7 @@ ___ ### getOrgHierarchy -▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](IOrganization.md)\> +▸ **getOrgHierarchy**(`namespace`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> #### Parameters @@ -359,13 +361,13 @@ ___ #### Returns -`Promise`<[`IOrganization`](IOrganization.md)\> +`Promise`<[`IOrganization`](modules_domains.IOrganization.md)\> ___ ### getOrganizationRoles -▸ **getOrganizationRoles**(`namespace`): `Promise`<[`IRole`](IRole.md)[]\> +▸ **getOrganizationRoles**(`namespace`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> #### Parameters @@ -375,13 +377,13 @@ ___ #### Returns -`Promise`<[`IRole`](IRole.md)[]\> +`Promise`<[`IRole`](modules_domains.IRole.md)[]\> ___ ### getOrganizationsByOwner -▸ **getOrganizationsByOwner**(`owner`, `excludeSubOrgs?`): `Promise`<[`IOrganization`](IOrganization.md)[]\> +▸ **getOrganizationsByOwner**(`owner`, `excludeSubOrgs?`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> #### Parameters @@ -392,13 +394,13 @@ ___ #### Returns -`Promise`<[`IOrganization`](IOrganization.md)[]\> +`Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> ___ ### getOwnedAssets -▸ **getOwnedAssets**(`owner`): `Promise`<[`Asset`](Asset.md)[]\> +▸ **getOwnedAssets**(`owner`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> #### Parameters @@ -408,13 +410,13 @@ ___ #### Returns -`Promise`<[`Asset`](Asset.md)[]\> +`Promise`<[`Asset`](modules_assets.Asset.md)[]\> ___ ### getPreviouslyOwnedAssets -▸ **getPreviouslyOwnedAssets**(`owner`): `Promise`<[`Asset`](Asset.md)[]\> +▸ **getPreviouslyOwnedAssets**(`owner`): `Promise`<[`Asset`](modules_assets.Asset.md)[]\> #### Parameters @@ -424,7 +426,7 @@ ___ #### Returns -`Promise`<[`Asset`](Asset.md)[]\> +`Promise`<[`Asset`](modules_assets.Asset.md)[]\> ___ @@ -446,7 +448,7 @@ ___ ### getRolesByOwner -▸ **getRolesByOwner**(`owner`): `Promise`<[`IRole`](IRole.md)[]\> +▸ **getRolesByOwner**(`owner`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\> #### Parameters @@ -456,7 +458,7 @@ ___ #### Returns -`Promise`<[`IRole`](IRole.md)[]\> +`Promise`<[`IRole`](modules_domains.IRole.md)[]\> ___ @@ -478,7 +480,7 @@ ___ ### getSubOrganizationsByOrganization -▸ **getSubOrganizationsByOrganization**(`namespace`): `Promise`<[`IOrganization`](IOrganization.md)[]\> +▸ **getSubOrganizationsByOrganization**(`namespace`): `Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> #### Parameters @@ -488,7 +490,7 @@ ___ #### Returns -`Promise`<[`IOrganization`](IOrganization.md)[]\> +`Promise`<[`IOrganization`](modules_domains.IOrganization.md)[]\> ___ @@ -511,7 +513,7 @@ ___ | Name | Type | | :------ | :------ | | `issuer` | `string` | -| `message` | [`IClaimIssuance`](IClaimIssuance.md) | +| `message` | [`IClaimIssuance`](modules_claims.IClaimIssuance.md) | #### Returns @@ -538,7 +540,7 @@ ___ | Name | Type | | :------ | :------ | | `issuer` | `string` | -| `message` | [`IClaimRejection`](IClaimRejection.md) | +| `message` | [`IClaimRejection`](modules_claims.IClaimRejection.md) | #### Returns @@ -554,7 +556,7 @@ ___ | Name | Type | | :------ | :------ | -| `message` | [`IClaimRequest`](IClaimRequest.md) | +| `message` | [`IClaimRequest`](modules_claims.IClaimRequest.md) | #### Returns diff --git a/docs/api/interfaces/modules_claims.Claim.md b/docs/api/interfaces/modules_claims.Claim.md new file mode 100644 index 00000000..2e0715d5 --- /dev/null +++ b/docs/api/interfaces/modules_claims.Claim.md @@ -0,0 +1,120 @@ +# Interface: Claim + +[modules/claims](../modules/modules_claims.md).Claim + +## Table of contents + +### Properties + +- [acceptedBy](modules_claims.Claim.md#acceptedby) +- [claimIssuer](modules_claims.Claim.md#claimissuer) +- [claimType](modules_claims.Claim.md#claimtype) +- [claimTypeVersion](modules_claims.Claim.md#claimtypeversion) +- [id](modules_claims.Claim.md#id) +- [isAccepted](modules_claims.Claim.md#isaccepted) +- [isRejected](modules_claims.Claim.md#isrejected) +- [issuedToken](modules_claims.Claim.md#issuedtoken) +- [namespace](modules_claims.Claim.md#namespace) +- [onChainProof](modules_claims.Claim.md#onchainproof) +- [redirectUri](modules_claims.Claim.md#redirecturi) +- [registrationTypes](modules_claims.Claim.md#registrationtypes) +- [requester](modules_claims.Claim.md#requester) +- [subject](modules_claims.Claim.md#subject) +- [subjectAgreement](modules_claims.Claim.md#subjectagreement) +- [token](modules_claims.Claim.md#token) + +## Properties + +### acceptedBy + +• `Optional` **acceptedBy**: `string` + +___ + +### claimIssuer + +• **claimIssuer**: `string`[] + +___ + +### claimType + +• **claimType**: `string` + +___ + +### claimTypeVersion + +• **claimTypeVersion**: `string` + +___ + +### id + +• **id**: `string` + +___ + +### isAccepted + +• **isAccepted**: `boolean` + +___ + +### isRejected + +• `Optional` **isRejected**: `boolean` + +___ + +### issuedToken + +• `Optional` **issuedToken**: `string` + +___ + +### namespace + +• **namespace**: `string` + +___ + +### onChainProof + +• `Optional` **onChainProof**: `string` + +___ + +### redirectUri + +• `Optional` **redirectUri**: `string` + +___ + +### registrationTypes + +• **registrationTypes**: [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[] + +___ + +### requester + +• **requester**: `string` + +___ + +### subject + +• **subject**: `string` + +___ + +### subjectAgreement + +• `Optional` **subjectAgreement**: `string` + +___ + +### token + +• **token**: `string` diff --git a/docs/api/interfaces/modules_claims.IClaimIssuance.md b/docs/api/interfaces/modules_claims.IClaimIssuance.md new file mode 100644 index 00000000..86cd9bdd --- /dev/null +++ b/docs/api/interfaces/modules_claims.IClaimIssuance.md @@ -0,0 +1,89 @@ +# Interface: IClaimIssuance + +[modules/claims](../modules/modules_claims.md).IClaimIssuance + +## Hierarchy + +- [`IMessage`](modules_messaging.IMessage.md) + + ↳ **`IClaimIssuance`** + +## Table of contents + +### Properties + +- [acceptedBy](modules_claims.IClaimIssuance.md#acceptedby) +- [claimIssuer](modules_claims.IClaimIssuance.md#claimissuer) +- [claimType](modules_claims.IClaimIssuance.md#claimtype) +- [claimTypeVersion](modules_claims.IClaimIssuance.md#claimtypeversion) +- [id](modules_claims.IClaimIssuance.md#id) +- [issuedToken](modules_claims.IClaimIssuance.md#issuedtoken) +- [onChainProof](modules_claims.IClaimIssuance.md#onchainproof) +- [requester](modules_claims.IClaimIssuance.md#requester) +- [vp](modules_claims.IClaimIssuance.md#vp) + +## Properties + +### acceptedBy + +• **acceptedBy**: `string` + +___ + +### claimIssuer + +• `Optional` **claimIssuer**: `string`[] + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[claimIssuer](modules_messaging.IMessage.md#claimissuer) + +___ + +### claimType + +• `Optional` **claimType**: `string` + +___ + +### claimTypeVersion + +• `Optional` **claimTypeVersion**: `string` + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[id](modules_messaging.IMessage.md#id) + +___ + +### issuedToken + +• `Optional` **issuedToken**: `string` + +___ + +### onChainProof + +• `Optional` **onChainProof**: `string` + +___ + +### requester + +• **requester**: `string` + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[requester](modules_messaging.IMessage.md#requester) + +___ + +### vp + +• `Optional` **vp**: `string` diff --git a/docs/api/interfaces/modules_claims.IClaimRejection.md b/docs/api/interfaces/modules_claims.IClaimRejection.md new file mode 100644 index 00000000..bf98785d --- /dev/null +++ b/docs/api/interfaces/modules_claims.IClaimRejection.md @@ -0,0 +1,61 @@ +# Interface: IClaimRejection + +[modules/claims](../modules/modules_claims.md).IClaimRejection + +## Hierarchy + +- [`IMessage`](modules_messaging.IMessage.md) + + ↳ **`IClaimRejection`** + +## Table of contents + +### Properties + +- [claimIssuer](modules_claims.IClaimRejection.md#claimissuer) +- [id](modules_claims.IClaimRejection.md#id) +- [isRejected](modules_claims.IClaimRejection.md#isrejected) +- [rejectionReason](modules_claims.IClaimRejection.md#rejectionreason) +- [requester](modules_claims.IClaimRejection.md#requester) + +## Properties + +### claimIssuer + +• `Optional` **claimIssuer**: `string`[] + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[claimIssuer](modules_messaging.IMessage.md#claimissuer) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[id](modules_messaging.IMessage.md#id) + +___ + +### isRejected + +• **isRejected**: `boolean` + +___ + +### rejectionReason + +• `Optional` **rejectionReason**: `string` + +___ + +### requester + +• **requester**: `string` + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[requester](modules_messaging.IMessage.md#requester) diff --git a/docs/api/interfaces/modules_claims.IClaimRequest.md b/docs/api/interfaces/modules_claims.IClaimRequest.md new file mode 100644 index 00000000..bb22e25b --- /dev/null +++ b/docs/api/interfaces/modules_claims.IClaimRequest.md @@ -0,0 +1,82 @@ +# Interface: IClaimRequest + +[modules/claims](../modules/modules_claims.md).IClaimRequest + +## Hierarchy + +- [`IMessage`](modules_messaging.IMessage.md) + + ↳ **`IClaimRequest`** + +## Table of contents + +### Properties + +- [claimIssuer](modules_claims.IClaimRequest.md#claimissuer) +- [claimType](modules_claims.IClaimRequest.md#claimtype) +- [claimTypeVersion](modules_claims.IClaimRequest.md#claimtypeversion) +- [id](modules_claims.IClaimRequest.md#id) +- [registrationTypes](modules_claims.IClaimRequest.md#registrationtypes) +- [requester](modules_claims.IClaimRequest.md#requester) +- [subjectAgreement](modules_claims.IClaimRequest.md#subjectagreement) +- [token](modules_claims.IClaimRequest.md#token) + +## Properties + +### claimIssuer + +• `Optional` **claimIssuer**: `string`[] + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[claimIssuer](modules_messaging.IMessage.md#claimissuer) + +___ + +### claimType + +• **claimType**: `string` + +___ + +### claimTypeVersion + +• **claimTypeVersion**: `string` + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[id](modules_messaging.IMessage.md#id) + +___ + +### registrationTypes + +• **registrationTypes**: [`RegistrationTypes`](../enums/modules_claims.RegistrationTypes.md)[] + +___ + +### requester + +• **requester**: `string` + +#### Inherited from + +[IMessage](modules_messaging.IMessage.md).[requester](modules_messaging.IMessage.md#requester) + +___ + +### subjectAgreement + +• `Optional` **subjectAgreement**: `string` + +___ + +### token + +• **token**: `string` diff --git a/docs/api/interfaces/AssetProfile.md b/docs/api/interfaces/modules_didRegistry.AssetProfile.md similarity index 50% rename from docs/api/interfaces/AssetProfile.md rename to docs/api/interfaces/modules_didRegistry.AssetProfile.md index 86f210a9..a0c51eb7 100644 --- a/docs/api/interfaces/AssetProfile.md +++ b/docs/api/interfaces/modules_didRegistry.AssetProfile.md @@ -1,11 +1,13 @@ # Interface: AssetProfile +[modules/didRegistry](../modules/modules_didRegistry.md).AssetProfile + ## Table of contents ### Properties -- [icon](AssetProfile.md#icon) -- [name](AssetProfile.md#name) +- [icon](modules_didRegistry.AssetProfile.md#icon) +- [name](modules_didRegistry.AssetProfile.md#name) ## Properties diff --git a/docs/api/interfaces/modules_didRegistry.AssetProfiles.md b/docs/api/interfaces/modules_didRegistry.AssetProfiles.md new file mode 100644 index 00000000..c4acbd45 --- /dev/null +++ b/docs/api/interfaces/modules_didRegistry.AssetProfiles.md @@ -0,0 +1,7 @@ +# Interface: AssetProfiles + +[modules/didRegistry](../modules/modules_didRegistry.md).AssetProfiles + +## Indexable + +▪ [key: `string`]: [`AssetProfile`](modules_didRegistry.AssetProfile.md) diff --git a/docs/api/interfaces/ClaimData.md b/docs/api/interfaces/modules_didRegistry.ClaimData.md similarity index 51% rename from docs/api/interfaces/ClaimData.md rename to docs/api/interfaces/modules_didRegistry.ClaimData.md index 73a23398..edbb089f 100644 --- a/docs/api/interfaces/ClaimData.md +++ b/docs/api/interfaces/modules_didRegistry.ClaimData.md @@ -1,5 +1,7 @@ # Interface: ClaimData +[modules/didRegistry](../modules/modules_didRegistry.md).ClaimData + ## Hierarchy - `Record`<`string`, `unknown`\> @@ -10,10 +12,10 @@ ### Properties -- [claimType](ClaimData.md#claimtype) -- [claimTypeVersion](ClaimData.md#claimtypeversion) -- [issuerFields](ClaimData.md#issuerfields) -- [profile](ClaimData.md#profile) +- [claimType](modules_didRegistry.ClaimData.md#claimtype) +- [claimTypeVersion](modules_didRegistry.ClaimData.md#claimtypeversion) +- [issuerFields](modules_didRegistry.ClaimData.md#issuerfields) +- [profile](modules_didRegistry.ClaimData.md#profile) ## Properties @@ -37,4 +39,4 @@ ___ ### profile -• `Optional` **profile**: [`Profile`](Profile.md) +• `Optional` **profile**: [`Profile`](modules_didRegistry.Profile.md) diff --git a/docs/api/interfaces/modules_didRegistry.Profile.md b/docs/api/interfaces/modules_didRegistry.Profile.md new file mode 100644 index 00000000..9f8dc873 --- /dev/null +++ b/docs/api/interfaces/modules_didRegistry.Profile.md @@ -0,0 +1,36 @@ +# Interface: Profile + +[modules/didRegistry](../modules/modules_didRegistry.md).Profile + +## Table of contents + +### Properties + +- [address](modules_didRegistry.Profile.md#address) +- [assetProfiles](modules_didRegistry.Profile.md#assetprofiles) +- [birthdate](modules_didRegistry.Profile.md#birthdate) +- [name](modules_didRegistry.Profile.md#name) + +## Properties + +### address + +• `Optional` **address**: `string` + +___ + +### assetProfiles + +• `Optional` **assetProfiles**: [`AssetProfiles`](modules_didRegistry.AssetProfiles.md) + +___ + +### birthdate + +• `Optional` **birthdate**: `string` + +___ + +### name + +• `Optional` **name**: `string` diff --git a/docs/api/interfaces/modules_domains.IApp.md b/docs/api/interfaces/modules_domains.IApp.md new file mode 100644 index 00000000..85c57884 --- /dev/null +++ b/docs/api/interfaces/modules_domains.IApp.md @@ -0,0 +1,57 @@ +# Interface: IApp + +[modules/domains](../modules/modules_domains.md).IApp + +## Table of contents + +### Properties + +- [definition](modules_domains.IApp.md#definition) +- [id](modules_domains.IApp.md#id) +- [isOwnedByCurrentUser](modules_domains.IApp.md#isownedbycurrentuser) +- [name](modules_domains.IApp.md#name) +- [namespace](modules_domains.IApp.md#namespace) +- [owner](modules_domains.IApp.md#owner) +- [roles](modules_domains.IApp.md#roles) + +## Properties + +### definition + +• **definition**: `IAppDefinition` + +___ + +### id + +• **id**: `number` + +___ + +### isOwnedByCurrentUser + +• `Optional` **isOwnedByCurrentUser**: `boolean` + +___ + +### name + +• **name**: `string` + +___ + +### namespace + +• **namespace**: `string` + +___ + +### owner + +• **owner**: `string` + +___ + +### roles + +• `Optional` **roles**: [`IRole`](modules_domains.IRole.md)[] diff --git a/docs/api/interfaces/modules_domains.IOrganization.md b/docs/api/interfaces/modules_domains.IOrganization.md new file mode 100644 index 00000000..903fde9b --- /dev/null +++ b/docs/api/interfaces/modules_domains.IOrganization.md @@ -0,0 +1,71 @@ +# Interface: IOrganization + +[modules/domains](../modules/modules_domains.md).IOrganization + +## Table of contents + +### Properties + +- [apps](modules_domains.IOrganization.md#apps) +- [definition](modules_domains.IOrganization.md#definition) +- [id](modules_domains.IOrganization.md#id) +- [isOwnedByCurrentUser](modules_domains.IOrganization.md#isownedbycurrentuser) +- [name](modules_domains.IOrganization.md#name) +- [namespace](modules_domains.IOrganization.md#namespace) +- [owner](modules_domains.IOrganization.md#owner) +- [roles](modules_domains.IOrganization.md#roles) +- [subOrgs](modules_domains.IOrganization.md#suborgs) + +## Properties + +### apps + +• `Optional` **apps**: [`IApp`](modules_domains.IApp.md)[] + +___ + +### definition + +• **definition**: `IOrganizationDefinition` + +___ + +### id + +• **id**: `number` + +___ + +### isOwnedByCurrentUser + +• `Optional` **isOwnedByCurrentUser**: `boolean` + +___ + +### name + +• **name**: `string` + +___ + +### namespace + +• **namespace**: `string` + +___ + +### owner + +• **owner**: `string` + +___ + +### roles + +• `Optional` **roles**: [`IRole`](modules_domains.IRole.md)[] + +___ + +### subOrgs + +• `Optional` **subOrgs**: [`IOrganization`](modules_domains.IOrganization.md)[] diff --git a/docs/api/interfaces/IRole.md b/docs/api/interfaces/modules_domains.IRole.md similarity index 51% rename from docs/api/interfaces/IRole.md rename to docs/api/interfaces/modules_domains.IRole.md index 1f5a8197..14929748 100644 --- a/docs/api/interfaces/IRole.md +++ b/docs/api/interfaces/modules_domains.IRole.md @@ -1,15 +1,17 @@ # Interface: IRole +[modules/domains](../modules/modules_domains.md).IRole + ## Table of contents ### Properties -- [definition](IRole.md#definition) -- [id](IRole.md#id) -- [isOwnedByCurrentUser](IRole.md#isownedbycurrentuser) -- [name](IRole.md#name) -- [namespace](IRole.md#namespace) -- [owner](IRole.md#owner) +- [definition](modules_domains.IRole.md#definition) +- [id](modules_domains.IRole.md#id) +- [isOwnedByCurrentUser](modules_domains.IRole.md#isownedbycurrentuser) +- [name](modules_domains.IRole.md#name) +- [namespace](modules_domains.IRole.md#namespace) +- [owner](modules_domains.IRole.md#owner) ## Properties diff --git a/docs/api/interfaces/modules_messaging.IMessage.md b/docs/api/interfaces/modules_messaging.IMessage.md new file mode 100644 index 00000000..1d443618 --- /dev/null +++ b/docs/api/interfaces/modules_messaging.IMessage.md @@ -0,0 +1,39 @@ +# Interface: IMessage + +[modules/messaging](../modules/modules_messaging.md).IMessage + +## Hierarchy + +- **`IMessage`** + + ↳ [`IClaimRequest`](modules_claims.IClaimRequest.md) + + ↳ [`IClaimIssuance`](modules_claims.IClaimIssuance.md) + + ↳ [`IClaimRejection`](modules_claims.IClaimRejection.md) + +## Table of contents + +### Properties + +- [claimIssuer](modules_messaging.IMessage.md#claimissuer) +- [id](modules_messaging.IMessage.md#id) +- [requester](modules_messaging.IMessage.md#requester) + +## Properties + +### claimIssuer + +• `Optional` **claimIssuer**: `string`[] + +___ + +### id + +• **id**: `string` + +___ + +### requester + +• **requester**: `string` diff --git a/docs/api/interfaces/modules_signer.IPubKeyAndIdentityToken.md b/docs/api/interfaces/modules_signer.IPubKeyAndIdentityToken.md new file mode 100644 index 00000000..a7c26ce4 --- /dev/null +++ b/docs/api/interfaces/modules_signer.IPubKeyAndIdentityToken.md @@ -0,0 +1,22 @@ +# Interface: IPubKeyAndIdentityToken + +[modules/signer](../modules/modules_signer.md).IPubKeyAndIdentityToken + +## Table of contents + +### Properties + +- [identityToken](modules_signer.IPubKeyAndIdentityToken.md#identitytoken) +- [publicKey](modules_signer.IPubKeyAndIdentityToken.md#publickey) + +## Properties + +### identityToken + +• **identityToken**: `string` + +___ + +### publicKey + +• **publicKey**: `string` diff --git a/docs/api/interfaces/modules_verifiable_credentials.CreatePresentationParams.md b/docs/api/interfaces/modules_verifiable_credentials.CreatePresentationParams.md new file mode 100644 index 00000000..c212a602 --- /dev/null +++ b/docs/api/interfaces/modules_verifiable_credentials.CreatePresentationParams.md @@ -0,0 +1,15 @@ +# Interface: CreatePresentationParams + +[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).CreatePresentationParams + +## Table of contents + +### Properties + +- [presentationDefinition](modules_verifiable_credentials.CreatePresentationParams.md#presentationdefinition) + +## Properties + +### presentationDefinition + +• `Optional` **presentationDefinition**: `IPresentationDefinition` diff --git a/docs/api/interfaces/modules_verifiable_credentials.IssuerFields.md b/docs/api/interfaces/modules_verifiable_credentials.IssuerFields.md new file mode 100644 index 00000000..8f2829b3 --- /dev/null +++ b/docs/api/interfaces/modules_verifiable_credentials.IssuerFields.md @@ -0,0 +1,22 @@ +# Interface: IssuerFields + +[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).IssuerFields + +## Table of contents + +### Properties + +- [key](modules_verifiable_credentials.IssuerFields.md#key) +- [value](modules_verifiable_credentials.IssuerFields.md#value) + +## Properties + +### key + +• **key**: `string` + +___ + +### value + +• **value**: `string` \| `number` diff --git a/docs/api/interfaces/modules_verifiable_credentials.ProofOptions.md b/docs/api/interfaces/modules_verifiable_credentials.ProofOptions.md new file mode 100644 index 00000000..d0036150 --- /dev/null +++ b/docs/api/interfaces/modules_verifiable_credentials.ProofOptions.md @@ -0,0 +1,22 @@ +# Interface: ProofOptions + +[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).ProofOptions + +## Table of contents + +### Properties + +- [proofPurpose](modules_verifiable_credentials.ProofOptions.md#proofpurpose) +- [verificationMethod](modules_verifiable_credentials.ProofOptions.md#verificationmethod) + +## Properties + +### proofPurpose + +• `Optional` **proofPurpose**: `string` + +___ + +### verificationMethod + +• `Optional` **verificationMethod**: `string` diff --git a/docs/api/interfaces/modules_verifiable_credentials.RoleCredentialSubject.md b/docs/api/interfaces/modules_verifiable_credentials.RoleCredentialSubject.md new file mode 100644 index 00000000..83160625 --- /dev/null +++ b/docs/api/interfaces/modules_verifiable_credentials.RoleCredentialSubject.md @@ -0,0 +1,46 @@ +# Interface: RoleCredentialSubject + +[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).RoleCredentialSubject + +## Hierarchy + +- `CredentialSubject` + + ↳ **`RoleCredentialSubject`** + +## Table of contents + +### Properties + +- [id](modules_verifiable_credentials.RoleCredentialSubject.md#id) +- [issuerFields](modules_verifiable_credentials.RoleCredentialSubject.md#issuerfields) +- [role](modules_verifiable_credentials.RoleCredentialSubject.md#role) + +## Properties + +### id + +• **id**: `string` + +#### Overrides + +CredentialSubject.id + +___ + +### issuerFields + +• **issuerFields**: [`IssuerFields`](modules_verifiable_credentials.IssuerFields.md)[] + +___ + +### role + +• **role**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | +| `version` | `string` | diff --git a/docs/api/interfaces/modules_verifiable_credentials.RoleCredentialSubjectParams.md b/docs/api/interfaces/modules_verifiable_credentials.RoleCredentialSubjectParams.md new file mode 100644 index 00000000..38f9aa3b --- /dev/null +++ b/docs/api/interfaces/modules_verifiable_credentials.RoleCredentialSubjectParams.md @@ -0,0 +1,36 @@ +# Interface: RoleCredentialSubjectParams + +[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).RoleCredentialSubjectParams + +## Table of contents + +### Properties + +- [id](modules_verifiable_credentials.RoleCredentialSubjectParams.md#id) +- [issuerFields](modules_verifiable_credentials.RoleCredentialSubjectParams.md#issuerfields) +- [namespace](modules_verifiable_credentials.RoleCredentialSubjectParams.md#namespace) +- [version](modules_verifiable_credentials.RoleCredentialSubjectParams.md#version) + +## Properties + +### id + +• **id**: `string` + +___ + +### issuerFields + +• `Optional` **issuerFields**: [`IssuerFields`](modules_verifiable_credentials.IssuerFields.md)[] + +___ + +### namespace + +• **namespace**: `string` + +___ + +### version + +• **version**: `string` diff --git a/docs/api/interfaces/modules_verifiable_credentials.VerifyVerifiableCredentialResults.md b/docs/api/interfaces/modules_verifiable_credentials.VerifyVerifiableCredentialResults.md new file mode 100644 index 00000000..2591c107 --- /dev/null +++ b/docs/api/interfaces/modules_verifiable_credentials.VerifyVerifiableCredentialResults.md @@ -0,0 +1,29 @@ +# Interface: VerifyVerifiableCredentialResults + +[modules/verifiable-credentials](../modules/modules_verifiable_credentials.md).VerifyVerifiableCredentialResults + +## Table of contents + +### Properties + +- [checks](modules_verifiable_credentials.VerifyVerifiableCredentialResults.md#checks) +- [errors](modules_verifiable_credentials.VerifyVerifiableCredentialResults.md#errors) +- [warnings](modules_verifiable_credentials.VerifyVerifiableCredentialResults.md#warnings) + +## Properties + +### checks + +• **checks**: `string`[] + +___ + +### errors + +• **errors**: `string`[] + +___ + +### warnings + +• **warnings**: `string`[] diff --git a/docs/api/modules.md b/docs/api/modules.md index 8f6a0626..a277a4b1 100644 --- a/docs/api/modules.md +++ b/docs/api/modules.md @@ -2,845 +2,15 @@ ## Table of contents -### Enumerations - -- [AssetHistoryEventType](enums/AssetHistoryEventType.md) -- [ClaimEventType](enums/ClaimEventType.md) -- [ERROR\_MESSAGES](enums/ERROR_MESSAGES.md) -- [ExecutionEnvironment](enums/ExecutionEnvironment.md) -- [MessagingMethod](enums/MessagingMethod.md) -- [NamespaceType](enums/NamespaceType.md) -- [Order](enums/Order.md) -- [ProviderEvent](enums/ProviderEvent.md) -- [ProviderType](enums/ProviderType.md) -- [RegistrationTypes](enums/RegistrationTypes.md) -- [SearchType](enums/SearchType.md) -- [StakeStatus](enums/StakeStatus.md) - -### Classes - -- [AssetsService](classes/AssetsService.md) -- [CacheClient](classes/CacheClient.md) -- [ChangeOwnershipNotPossibleError](classes/ChangeOwnershipNotPossibleError.md) -- [ClaimsService](classes/ClaimsService.md) -- [DeletingNamespaceNotPossibleError](classes/DeletingNamespaceNotPossibleError.md) -- [DidRegistry](classes/DidRegistry.md) -- [DomainsService](classes/DomainsService.md) -- [ENSOwnerNotValidAddressError](classes/ENSOwnerNotValidAddressError.md) -- [ENSTypeNotSupportedError](classes/ENSTypeNotSupportedError.md) -- [EkcSigner](classes/EkcSigner.md) -- [MalformedDIDError](classes/MalformedDIDError.md) -- [MessagingService](classes/MessagingService.md) -- [MethodNotAvailableInNodeEnvError](classes/MethodNotAvailableInNodeEnvError.md) -- [SignerService](classes/SignerService.md) -- [StakingFactoryService](classes/StakingFactoryService.md) -- [StakingPoolService](classes/StakingPoolService.md) -- [VerifiableCredentialsServiceBase](classes/VerifiableCredentialsServiceBase.md) - -### Interfaces - -- [Asset](interfaces/Asset.md) -- [AssetHistory](interfaces/AssetHistory.md) -- [AssetProfile](interfaces/AssetProfile.md) -- [AssetProfiles](interfaces/AssetProfiles.md) -- [CacheServerClientOptions](interfaces/CacheServerClientOptions.md) -- [ChainConfig](interfaces/ChainConfig.md) -- [Claim](interfaces/Claim.md) -- [ClaimData](interfaces/ClaimData.md) -- [CreatePresentationParams](interfaces/CreatePresentationParams.md) -- [IApp](interfaces/IApp.md) -- [ICacheClient](interfaces/ICacheClient.md) -- [IClaimIssuance](interfaces/IClaimIssuance.md) -- [IClaimRejection](interfaces/IClaimRejection.md) -- [IClaimRequest](interfaces/IClaimRequest.md) -- [IMessage](interfaces/IMessage.md) -- [IOrganization](interfaces/IOrganization.md) -- [IPubKeyAndIdentityToken](interfaces/IPubKeyAndIdentityToken.md) -- [IRole](interfaces/IRole.md) -- [IssuerFields](interfaces/IssuerFields.md) -- [MessagingConfig](interfaces/MessagingConfig.md) -- [Profile](interfaces/Profile.md) -- [ProofOptions](interfaces/ProofOptions.md) -- [RoleCredentialSubject](interfaces/RoleCredentialSubject.md) -- [RoleCredentialSubjectParams](interfaces/RoleCredentialSubjectParams.md) -- [VerifyVerifiableCredentialResults](interfaces/VerifyVerifiableCredentialResults.md) - -### Type aliases - -- [AccountInfo](modules.md#accountinfo) -- [AssetsFilter](modules.md#assetsfilter) -- [ChainId](modules.md#chainid) -- [ClaimsFilter](modules.md#claimsfilter) -- [IssueClaim](modules.md#issueclaim) -- [MulticallTx](modules.md#multicalltx) -- [RejectClaim](modules.md#rejectclaim) -- [RequestClaim](modules.md#requestclaim) -- [Service](modules.md#service) -- [ServiceInitializer](modules.md#serviceinitializer) -- [SignerT](modules.md#signert) -- [Stake](modules.md#stake) - -### Variables - -- [IS\_ETH\_SIGNER](modules.md#is_eth_signer) -- [NODE\_FIELDS\_KEY](modules.md#node_fields_key) -- [PUBLIC\_KEY](modules.md#public_key) -- [TEST\_LOGIN\_ENDPOINT](modules.md#test_login_endpoint) -- [VOLTA\_CHAIN\_ID](modules.md#volta_chain_id) -- [agreement\_type\_hash](modules.md#agreement_type_hash) -- [defaultAzureProxyUrl](modules.md#defaultazureproxyurl) -- [defaultBridgeUrl](modules.md#defaultbridgeurl) -- [defaultClaimExpiry](modules.md#defaultclaimexpiry) -- [defaultKmsServerUrl](modules.md#defaultkmsserverurl) -- [didPattern](modules.md#didpattern) -- [emptyAddress](modules.md#emptyaddress) -- [erc712\_type\_hash](modules.md#erc712_type_hash) -- [proof\_type\_hash](modules.md#proof_type_hash) -- [typedMsgPrefix](modules.md#typedmsgprefix) -- [verifiableCredentialEIP712Types](modules.md#verifiablecredentialeip712types) -- [verifiablePresentationEIP712Types](modules.md#verifiablepresentationeip712types) -- [verifiablePresentationWithCredentialEIP712Types](modules.md#verifiablepresentationwithcredentialeip712types) - -### Functions - -- [addSupportedDID](modules.md#addsupporteddid) -- [cacheConfigs](modules.md#cacheconfigs) -- [castToV2](modules.md#casttov2) -- [chainConfigs](modules.md#chainconfigs) -- [compareDID](modules.md#comparedid) -- [createWalletConnectProvider](modules.md#createwalletconnectprovider) -- [executionEnvironment](modules.md#executionenvironment) -- [fromGnosis](modules.md#fromgnosis) -- [fromKms](modules.md#fromkms) -- [fromMetaMask](modules.md#frommetamask) -- [fromPrivateKey](modules.md#fromprivatekey) -- [fromWalletConnectMetamask](modules.md#fromwalletconnectmetamask) -- [getMessagingConfig](modules.md#getmessagingconfig) -- [getVerifiableCredentialsService](modules.md#getverifiablecredentialsservice) -- [init](modules.md#init) -- [initWithEKC](modules.md#initwithekc) -- [initWithGnosis](modules.md#initwithgnosis) -- [initWithKms](modules.md#initwithkms) -- [initWithMetamask](modules.md#initwithmetamask) -- [initWithPrivateKeySigner](modules.md#initwithprivatekeysigner) -- [initWithWalletConnect](modules.md#initwithwalletconnect) -- [isMetamaskExtensionPresent](modules.md#ismetamaskextensionpresent) -- [isValidDID](modules.md#isvaliddid) -- [readyToBeRegisteredOnchain](modules.md#readytoberegisteredonchain) -- [setCacheConfig](modules.md#setcacheconfig) -- [setChainConfig](modules.md#setchainconfig) -- [setMessagingConfig](modules.md#setmessagingconfig) -- [supportedDIDMethods](modules.md#supporteddidmethods) - -## Type aliases - -### AccountInfo - -Ƭ **AccountInfo**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `account` | `string` | -| `chainId` | `number` | -| `chainName` | `string` | - -___ - -### AssetsFilter - -Ƭ **AssetsFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `order?` | [`Order`](enums/Order.md) | -| `skip?` | `number` | -| `take?` | `number` | -| `type?` | [`AssetHistoryEventType`](enums/AssetHistoryEventType.md) | - -___ - -### ChainId - -Ƭ **ChainId**: `number` - -___ - -### ClaimsFilter - -Ƭ **ClaimsFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `isAccepted?` | `boolean` | -| `namespace?` | `string` | - -___ - -### IssueClaim - -Ƭ **IssueClaim**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `issuer` | `string` | -| `message` | [`IClaimIssuance`](interfaces/IClaimIssuance.md) | - -___ - -### MulticallTx - -Ƭ **MulticallTx**: { `info`: `string` ; `tx`: `EncodedCall` ; `next`: (`opts?`: { `retryCheck?`: `boolean` }) => `Promise`<`undefined` \| `TransactionReceipt`\> }[] - -___ - -### RejectClaim - -Ƭ **RejectClaim**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `issuer` | `string` | -| `message` | [`IClaimRejection`](interfaces/IClaimRejection.md) | - -___ - -### RequestClaim - -Ƭ **RequestClaim**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `message` | [`IClaimRequest`](interfaces/IClaimRequest.md) | -| `requester` | `string` | - -___ - -### Service - -Ƭ **Service**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `org` | `string` | organization ENS name | -| `pool` | `string` | pool address | -| `provider` | `string` | provider address | - -___ - -### ServiceInitializer - -Ƭ **ServiceInitializer**: () => `Promise`<`void`\> - -#### Type declaration - -▸ (): `Promise`<`void`\> - -##### Returns - -`Promise`<`void`\> - -___ - -### SignerT - -Ƭ **SignerT**: `Signer` & `TypedDataSigner` - -___ - -### Stake - -Ƭ **Stake**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | `BigNumber` | -| `depositEnd` | `BigNumber` | -| `depositStart` | `BigNumber` | -| `status` | [`StakeStatus`](enums/StakeStatus.md) | - -## Variables - -### IS\_ETH\_SIGNER - -• `Const` **IS\_ETH\_SIGNER**: ``"isEthSigner"`` - -___ - -### NODE\_FIELDS\_KEY - -• `Const` **NODE\_FIELDS\_KEY**: ``"metadata"`` - -___ - -### PUBLIC\_KEY - -• `Const` **PUBLIC\_KEY**: ``"PublicKey"`` - -___ - -### TEST\_LOGIN\_ENDPOINT - -• `Const` **TEST\_LOGIN\_ENDPOINT**: ``"/auth/status"`` - -___ - -### VOLTA\_CHAIN\_ID - -• `Const` **VOLTA\_CHAIN\_ID**: ``73799`` - -___ - -### agreement\_type\_hash - -• `Const` **agreement\_type\_hash**: `string` - -___ - -### defaultAzureProxyUrl - -• `Const` **defaultAzureProxyUrl**: ``"https://azure-proxy-server.energyweb.org/api/v1"`` - -___ - -### defaultBridgeUrl - -• `Const` **defaultBridgeUrl**: ``"https://bridge.walletconnect.org"`` - -___ - -### defaultClaimExpiry - -• `Const` **defaultClaimExpiry**: `number` - -___ - -### defaultKmsServerUrl - -• `Const` **defaultKmsServerUrl**: ``"https://km.aws.energyweb.org/connect/new"`` - -___ - -### didPattern - -• `Const` **didPattern**: ``"^(?:did:(?[a-z0-9]+?):)((?[a-z0-9]+?):)?(?0x[A-Fa-f0-9]{40})$"`` - -___ - -### emptyAddress - -• `Const` **emptyAddress**: ``"0x0000000000000000000000000000000000000000"`` - -___ - -### erc712\_type\_hash - -• `Const` **erc712\_type\_hash**: `string` - -___ - -### proof\_type\_hash - -• `Const` **proof\_type\_hash**: `string` - -___ - -### typedMsgPrefix - -• `Const` **typedMsgPrefix**: ``"1901"`` - -___ - -### verifiableCredentialEIP712Types - -• `Const` **verifiableCredentialEIP712Types**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `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' }[] | -| `VerifiableCredential` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | - -___ - -### verifiablePresentationEIP712Types - -• `Const` **verifiablePresentationEIP712Types**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `EIP712Domain` | `never`[] | -| `Proof` | { `name`: `string` = '@context'; `type`: `string` = 'string' }[] | -| `VerifiablePresentation` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | - -___ - -### verifiablePresentationWithCredentialEIP712Types - -• `Const` **verifiablePresentationWithCredentialEIP712Types**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `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' }[] | -| `VC712Domain` | { `name`: `string` = 'domain'; `type`: `string` = 'VC712DomainData' }[] | -| `VC712DomainData` | `never`[] | -| `VC712DomainSchema` | { `name`: `string` = 'CredentialSubject'; `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 - -### addSupportedDID - -▸ **addSupportedDID**(`methodWithChain`, `validator`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodWithChain` | `string` | -| `validator` | (`did`: `string`) => `boolean` | - -#### Returns - -`void` - -___ - -### cacheConfigs - -▸ **cacheConfigs**(): `Object` - -#### Returns - -`Object` - -___ - -### castToV2 - -▸ **castToV2**(`roleDef`): `IRoleDefinitionV2` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `roleDef` | `IRoleDefinition` \| `IRoleDefinitionV2` | - -#### Returns - -`IRoleDefinitionV2` - -___ - -### chainConfigs - -▸ **chainConfigs**(): `Object` - -#### Returns - -`Object` - -___ - -### compareDID - -▸ **compareDID**(`didA`, `didB`): `boolean` - -**`description`** For verification which envolves legacy and chain-specific DID's - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `didA` | `string` | -| `didB` | `string` | - -#### Returns - -`boolean` - -___ - -### createWalletConnectProvider - -▸ **createWalletConnectProvider**(`bridge`, `infuraId?`): `WalletConnectProvider` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bridge` | `string` | -| `infuraId?` | `string` | - -#### Returns - -`WalletConnectProvider` - -___ - -### executionEnvironment - -▸ **executionEnvironment**(): `ExecutionEnvironment` - -#### Returns - -`ExecutionEnvironment` - -___ - -### fromGnosis - -▸ **fromGnosis**(`safeAppSdk`): `Promise`<[`SignerService`](classes/SignerService.md)\> - -**`description`** Intended for use in Volta Gnosis web interface(https://volta.gnosis-safe.io/). -Dapp should provide SafeAppSdk injected by Gnosis interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `safeAppSdk` | `SafeAppsSDK` | - -#### Returns - -`Promise`<[`SignerService`](classes/SignerService.md)\> - -___ - -### fromKms - -▸ **fromKms**(`bridge`, `kmsServerUrl`, `infuraId?`): `Promise`<[`SignerService`](classes/SignerService.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bridge` | `string` | -| `kmsServerUrl` | `string` | -| `infuraId?` | `string` | - -#### Returns - -`Promise`<[`SignerService`](classes/SignerService.md)\> - -___ - -### fromMetaMask - -▸ **fromMetaMask**(): `Promise`<[`SignerService`](classes/SignerService.md)\> - -#### Returns - -`Promise`<[`SignerService`](classes/SignerService.md)\> - -___ - -### fromPrivateKey - -▸ **fromPrivateKey**(`privateKey`, `rpcUrl`): `Promise`<[`SignerService`](classes/SignerService.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` | -| `rpcUrl` | `string` | - -#### Returns - -`Promise`<[`SignerService`](classes/SignerService.md)\> - -___ - -### fromWalletConnectMetamask - -▸ **fromWalletConnectMetamask**(`bridge`, `infuraId?`): `Promise`<[`SignerService`](classes/SignerService.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bridge` | `string` | -| `infuraId?` | `string` | - -#### Returns - -`Promise`<[`SignerService`](classes/SignerService.md)\> - -___ - -### getMessagingConfig - -▸ **getMessagingConfig**(): `Object` - -#### Returns - -`Object` - -___ - -### getVerifiableCredentialsService - -▸ **getVerifiableCredentialsService**(`signerService`): `Promise`<[`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerService` | [`SignerService`](classes/SignerService.md) | - -#### Returns - -`Promise`<[`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md)\> - -___ - -### init - -▸ **init**(`signerService`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerService` | [`SignerService`](classes/SignerService.md) | - -#### Returns - -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -___ - -### initWithEKC - -▸ **initWithEKC**(`proxyUrl?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `proxyUrl` | `string` | `defaultAzureProxyUrl` | - -#### Returns - -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -___ - -### initWithGnosis - -▸ **initWithGnosis**(`safeAppSdk`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `safeAppSdk` | `SafeAppsSDK` | - -#### Returns - -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -___ - -### initWithKms - -▸ **initWithKms**(`__namedParameters?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.bridge` | `undefined` \| `string` | -| `__namedParameters.kmsServerUrl` | `undefined` \| `string` | - -#### Returns - -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -___ - -### initWithMetamask - -▸ **initWithMetamask**(): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -#### Returns - -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -___ - -### initWithPrivateKeySigner - -▸ **initWithPrivateKeySigner**(`privateKey`, `rpcUrl`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` | -| `rpcUrl` | `string` | - -#### Returns - -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -___ - -### initWithWalletConnect - -▸ **initWithWalletConnect**(`bridge?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `bridge` | `string` | `defaultBridgeUrl` | - -#### Returns - -`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](classes/AssetsService.md) ; `cacheClient`: [`CacheClient`](classes/CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](classes/ClaimsService.md) ; `didRegistry`: [`DidRegistry`](classes/DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](classes/DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](classes/StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](classes/MessagingService.md) ; `signerService`: [`SignerService`](classes/SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](classes/VerifiableCredentialsServiceBase.md) }\> - -___ - -### isMetamaskExtensionPresent - -▸ **isMetamaskExtensionPresent**(): `Promise`<{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\> - -#### Returns - -`Promise`<{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\> - -___ - -### isValidDID - -▸ **isValidDID**(`did`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `did` | `string` | - -#### Returns - -`boolean` - -___ - -### readyToBeRegisteredOnchain - -▸ **readyToBeRegisteredOnchain**(`claim`): claim is Required\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `claim` | `Record`<`string`, `unknown`\> | - -#### Returns - -claim is Required\> - -___ - -### setCacheConfig - -▸ **setCacheConfig**(`chainId`, `options`): `void` - -Used to override existing cache server configuration or add a missing one -Configuration must be set before constructing `IAM` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `options` | `Partial`<[`CacheServerClientOptions`](interfaces/CacheServerClientOptions.md)\> | - -#### Returns - -`void` - -___ - -### setChainConfig - -▸ **setChainConfig**(`chainId`, `config`): `void` - -Used to override existing chain configuration or add a missing one -Configuration must be set before constructing `IAM` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `config` | `Partial`<[`ChainConfig`](interfaces/ChainConfig.md)\> | - -#### Returns - -`void` - -___ - -### setMessagingConfig - -▸ **setMessagingConfig**(`chainId`, `options`): `void` - -Used to override existing messaging configuration or add a missing one -Configuration must be set before constructing `IAM` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `chainId` | `number` | -| `options` | `Partial`<[`MessagingConfig`](interfaces/MessagingConfig.md)\> | - -#### Returns - -`void` - -___ - -### supportedDIDMethods - -▸ **supportedDIDMethods**(): `string`[] - -#### Returns - -`string`[] +### Modules + +- [init](modules/init.md) +- [modules/assets](modules/modules_assets.md) +- [modules/cacheClient](modules/modules_cacheClient.md) +- [modules/claims](modules/modules_claims.md) +- [modules/didRegistry](modules/modules_didRegistry.md) +- [modules/domains](modules/modules_domains.md) +- [modules/messaging](modules/modules_messaging.md) +- [modules/signer](modules/modules_signer.md) +- [modules/staking](modules/modules_staking.md) +- [modules/verifiable-credentials](modules/modules_verifiable_credentials.md) diff --git a/docs/api/modules/init.md b/docs/api/modules/init.md new file mode 100644 index 00000000..64bfe72e --- /dev/null +++ b/docs/api/modules/init.md @@ -0,0 +1,122 @@ +# Module: init + +## Table of contents + +### Functions + +- [init](init.md#init) +- [initWithEKC](init.md#initwithekc) +- [initWithGnosis](init.md#initwithgnosis) +- [initWithKms](init.md#initwithkms) +- [initWithMetamask](init.md#initwithmetamask) +- [initWithPrivateKeySigner](init.md#initwithprivatekeysigner) +- [initWithWalletConnect](init.md#initwithwalletconnect) + +## Functions + +### init + +▸ **init**(`signerService`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerService` | [`SignerService`](../classes/modules_signer.SignerService.md) | + +#### Returns + +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +___ + +### initWithEKC + +▸ **initWithEKC**(`proxyUrl?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `proxyUrl` | `string` | `defaultAzureProxyUrl` | + +#### Returns + +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +___ + +### initWithGnosis + +▸ **initWithGnosis**(`safeAppSdk`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `safeAppSdk` | `SafeAppsSDK` | + +#### Returns + +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +___ + +### initWithKms + +▸ **initWithKms**(`__namedParameters?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.bridge` | `undefined` \| `string` | +| `__namedParameters.kmsServerUrl` | `undefined` \| `string` | + +#### Returns + +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +___ + +### initWithMetamask + +▸ **initWithMetamask**(): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +#### Returns + +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +___ + +### initWithPrivateKeySigner + +▸ **initWithPrivateKeySigner**(`privateKey`, `rpcUrl`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `privateKey` | `string` | +| `rpcUrl` | `string` | + +#### Returns + +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +___ + +### initWithWalletConnect + +▸ **initWithWalletConnect**(`bridge?`): `Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `bridge` | `string` | `defaultBridgeUrl` | + +#### Returns + +`Promise`<{ `connectToCacheServer`: () => `Promise`<{ `assetsService`: [`AssetsService`](../classes/modules_assets.AssetsService.md) ; `cacheClient`: [`CacheClient`](../classes/modules_cacheClient.CacheClient.md) ; `connectToDidRegistry`: (`ipfsStore?`: `string`) => `Promise`<{ `claimsService`: [`ClaimsService`](../classes/modules_claims.ClaimsService.md) ; `didRegistry`: [`DidRegistry`](../classes/modules_didRegistry.DidRegistry.md) }\> ; `domainsService`: [`DomainsService`](../classes/modules_domains.DomainsService.md) ; `stakingPoolService`: ``null`` \| [`StakingFactoryService`](../classes/modules_staking.StakingFactoryService.md) }\> ; `messagingService`: [`MessagingService`](../classes/modules_messaging.MessagingService.md) ; `signerService`: [`SignerService`](../classes/modules_signer.SignerService.md) ; `verifiableCredentialsService`: [`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) }\> diff --git a/docs/api/modules/modules_assets.md b/docs/api/modules/modules_assets.md new file mode 100644 index 00000000..a7527837 --- /dev/null +++ b/docs/api/modules/modules_assets.md @@ -0,0 +1,16 @@ +# Module: modules/assets + +## Table of contents + +### Enumerations + +- [AssetHistoryEventType](../enums/modules_assets.AssetHistoryEventType.md) + +### Classes + +- [AssetsService](../classes/modules_assets.AssetsService.md) + +### Interfaces + +- [Asset](../interfaces/modules_assets.Asset.md) +- [AssetHistory](../interfaces/modules_assets.AssetHistory.md) diff --git a/docs/api/modules/modules_cacheClient.md b/docs/api/modules/modules_cacheClient.md new file mode 100644 index 00000000..428f72a8 --- /dev/null +++ b/docs/api/modules/modules_cacheClient.md @@ -0,0 +1,60 @@ +# Module: modules/cacheClient + +## Table of contents + +### Enumerations + +- [Order](../enums/modules_cacheClient.Order.md) +- [SearchType](../enums/modules_cacheClient.SearchType.md) + +### Classes + +- [CacheClient](../classes/modules_cacheClient.CacheClient.md) + +### Interfaces + +- [CacheServerClientOptions](../interfaces/modules_cacheClient.CacheServerClientOptions.md) +- [ICacheClient](../interfaces/modules_cacheClient.ICacheClient.md) + +### Type aliases + +- [AssetsFilter](modules_cacheClient.md#assetsfilter) +- [ClaimsFilter](modules_cacheClient.md#claimsfilter) + +### Variables + +- [TEST\_LOGIN\_ENDPOINT](modules_cacheClient.md#test_login_endpoint) + +## Type aliases + +### AssetsFilter + +Ƭ **AssetsFilter**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order?` | [`Order`](../enums/modules_cacheClient.Order.md) | +| `skip?` | `number` | +| `take?` | `number` | +| `type?` | [`AssetHistoryEventType`](../enums/modules_assets.AssetHistoryEventType.md) | + +___ + +### ClaimsFilter + +Ƭ **ClaimsFilter**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `isAccepted?` | `boolean` | +| `namespace?` | `string` | + +## Variables + +### TEST\_LOGIN\_ENDPOINT + +• `Const` **TEST\_LOGIN\_ENDPOINT**: ``"/auth/status"`` diff --git a/docs/api/modules/modules_claims.md b/docs/api/modules/modules_claims.md new file mode 100644 index 00000000..2d928436 --- /dev/null +++ b/docs/api/modules/modules_claims.md @@ -0,0 +1,122 @@ +# Module: modules/claims + +## Table of contents + +### Enumerations + +- [ClaimEventType](../enums/modules_claims.ClaimEventType.md) +- [RegistrationTypes](../enums/modules_claims.RegistrationTypes.md) + +### Classes + +- [ClaimsService](../classes/modules_claims.ClaimsService.md) + +### Interfaces + +- [Claim](../interfaces/modules_claims.Claim.md) +- [IClaimIssuance](../interfaces/modules_claims.IClaimIssuance.md) +- [IClaimRejection](../interfaces/modules_claims.IClaimRejection.md) +- [IClaimRequest](../interfaces/modules_claims.IClaimRequest.md) + +### Type aliases + +- [IssueClaim](modules_claims.md#issueclaim) +- [RejectClaim](modules_claims.md#rejectclaim) +- [RequestClaim](modules_claims.md#requestclaim) + +### Variables + +- [agreement\_type\_hash](modules_claims.md#agreement_type_hash) +- [defaultClaimExpiry](modules_claims.md#defaultclaimexpiry) +- [erc712\_type\_hash](modules_claims.md#erc712_type_hash) +- [proof\_type\_hash](modules_claims.md#proof_type_hash) +- [typedMsgPrefix](modules_claims.md#typedmsgprefix) + +### Functions + +- [readyToBeRegisteredOnchain](modules_claims.md#readytoberegisteredonchain) + +## Type aliases + +### IssueClaim + +Ƭ **IssueClaim**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `issuer` | `string` | +| `message` | [`IClaimIssuance`](../interfaces/modules_claims.IClaimIssuance.md) | + +___ + +### RejectClaim + +Ƭ **RejectClaim**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `issuer` | `string` | +| `message` | [`IClaimRejection`](../interfaces/modules_claims.IClaimRejection.md) | + +___ + +### RequestClaim + +Ƭ **RequestClaim**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `message` | [`IClaimRequest`](../interfaces/modules_claims.IClaimRequest.md) | +| `requester` | `string` | + +## Variables + +### agreement\_type\_hash + +• `Const` **agreement\_type\_hash**: `string` + +___ + +### defaultClaimExpiry + +• `Const` **defaultClaimExpiry**: `number` + +___ + +### erc712\_type\_hash + +• `Const` **erc712\_type\_hash**: `string` + +___ + +### proof\_type\_hash + +• `Const` **proof\_type\_hash**: `string` + +___ + +### typedMsgPrefix + +• `Const` **typedMsgPrefix**: ``"1901"`` + +## Functions + +### readyToBeRegisteredOnchain + +▸ **readyToBeRegisteredOnchain**(`claim`): claim is Required\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `claim` | `Record`<`string`, `unknown`\> | + +#### Returns + +claim is Required\> diff --git a/docs/api/modules/modules_didRegistry.md b/docs/api/modules/modules_didRegistry.md new file mode 100644 index 00000000..7521ab7b --- /dev/null +++ b/docs/api/modules/modules_didRegistry.md @@ -0,0 +1,14 @@ +# Module: modules/didRegistry + +## Table of contents + +### Classes + +- [DidRegistry](../classes/modules_didRegistry.DidRegistry.md) + +### Interfaces + +- [AssetProfile](../interfaces/modules_didRegistry.AssetProfile.md) +- [AssetProfiles](../interfaces/modules_didRegistry.AssetProfiles.md) +- [ClaimData](../interfaces/modules_didRegistry.ClaimData.md) +- [Profile](../interfaces/modules_didRegistry.Profile.md) diff --git a/docs/api/modules/modules_domains.md b/docs/api/modules/modules_domains.md new file mode 100644 index 00000000..a863b0bc --- /dev/null +++ b/docs/api/modules/modules_domains.md @@ -0,0 +1,57 @@ +# Module: modules/domains + +## Table of contents + +### Enumerations + +- [NamespaceType](../enums/modules_domains.NamespaceType.md) + +### Classes + +- [DomainsService](../classes/modules_domains.DomainsService.md) + +### Interfaces + +- [IApp](../interfaces/modules_domains.IApp.md) +- [IOrganization](../interfaces/modules_domains.IOrganization.md) +- [IRole](../interfaces/modules_domains.IRole.md) + +### Type aliases + +- [MulticallTx](modules_domains.md#multicalltx) + +### Variables + +- [NODE\_FIELDS\_KEY](modules_domains.md#node_fields_key) + +### Functions + +- [castToV2](modules_domains.md#casttov2) + +## Type aliases + +### MulticallTx + +Ƭ **MulticallTx**: { `info`: `string` ; `tx`: `EncodedCall` ; `next`: (`opts?`: { `retryCheck?`: `boolean` }) => `Promise`<`undefined` \| `TransactionReceipt`\> }[] + +## Variables + +### NODE\_FIELDS\_KEY + +• `Const` **NODE\_FIELDS\_KEY**: ``"metadata"`` + +## Functions + +### castToV2 + +▸ **castToV2**(`roleDef`): `IRoleDefinitionV2` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `roleDef` | `IRoleDefinition` \| `IRoleDefinitionV2` | + +#### Returns + +`IRoleDefinitionV2` diff --git a/docs/api/modules/modules_messaging.md b/docs/api/modules/modules_messaging.md new file mode 100644 index 00000000..61ac17b0 --- /dev/null +++ b/docs/api/modules/modules_messaging.md @@ -0,0 +1,15 @@ +# Module: modules/messaging + +## Table of contents + +### Enumerations + +- [MessagingMethod](../enums/modules_messaging.MessagingMethod.md) + +### Classes + +- [MessagingService](../classes/modules_messaging.MessagingService.md) + +### Interfaces + +- [IMessage](../interfaces/modules_messaging.IMessage.md) diff --git a/docs/api/modules/modules_signer.md b/docs/api/modules/modules_signer.md new file mode 100644 index 00000000..120b972f --- /dev/null +++ b/docs/api/modules/modules_signer.md @@ -0,0 +1,192 @@ +# Module: modules/signer + +## Table of contents + +### Enumerations + +- [ProviderEvent](../enums/modules_signer.ProviderEvent.md) +- [ProviderType](../enums/modules_signer.ProviderType.md) + +### Classes + +- [EkcSigner](../classes/modules_signer.EkcSigner.md) +- [SignerService](../classes/modules_signer.SignerService.md) + +### Interfaces + +- [IPubKeyAndIdentityToken](../interfaces/modules_signer.IPubKeyAndIdentityToken.md) + +### Type aliases + +- [AccountInfo](modules_signer.md#accountinfo) +- [ServiceInitializer](modules_signer.md#serviceinitializer) +- [SignerT](modules_signer.md#signert) + +### Variables + +- [IS\_ETH\_SIGNER](modules_signer.md#is_eth_signer) +- [PUBLIC\_KEY](modules_signer.md#public_key) + +### Functions + +- [createWalletConnectProvider](modules_signer.md#createwalletconnectprovider) +- [fromGnosis](modules_signer.md#fromgnosis) +- [fromKms](modules_signer.md#fromkms) +- [fromMetaMask](modules_signer.md#frommetamask) +- [fromPrivateKey](modules_signer.md#fromprivatekey) +- [fromWalletConnectMetamask](modules_signer.md#fromwalletconnectmetamask) +- [isMetamaskExtensionPresent](modules_signer.md#ismetamaskextensionpresent) + +## Type aliases + +### AccountInfo + +Ƭ **AccountInfo**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `account` | `string` | +| `chainId` | `number` | +| `chainName` | `string` | + +___ + +### ServiceInitializer + +Ƭ **ServiceInitializer**: () => `Promise`<`void`\> + +#### Type declaration + +▸ (): `Promise`<`void`\> + +##### Returns + +`Promise`<`void`\> + +___ + +### SignerT + +Ƭ **SignerT**: `Signer` & `TypedDataSigner` + +## Variables + +### IS\_ETH\_SIGNER + +• `Const` **IS\_ETH\_SIGNER**: ``"isEthSigner"`` + +___ + +### PUBLIC\_KEY + +• `Const` **PUBLIC\_KEY**: ``"PublicKey"`` + +## Functions + +### createWalletConnectProvider + +▸ **createWalletConnectProvider**(`bridge`, `infuraId?`): `WalletConnectProvider` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bridge` | `string` | +| `infuraId?` | `string` | + +#### Returns + +`WalletConnectProvider` + +___ + +### 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 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `safeAppSdk` | `SafeAppsSDK` | + +#### Returns + +`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +___ + +### fromKms + +▸ **fromKms**(`bridge`, `kmsServerUrl`, `infuraId?`): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bridge` | `string` | +| `kmsServerUrl` | `string` | +| `infuraId?` | `string` | + +#### Returns + +`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +___ + +### fromMetaMask + +▸ **fromMetaMask**(): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +#### Returns + +`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +___ + +### fromPrivateKey + +▸ **fromPrivateKey**(`privateKey`, `rpcUrl`): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `privateKey` | `string` | +| `rpcUrl` | `string` | + +#### Returns + +`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +___ + +### fromWalletConnectMetamask + +▸ **fromWalletConnectMetamask**(`bridge`, `infuraId?`): `Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bridge` | `string` | +| `infuraId?` | `string` | + +#### Returns + +`Promise`<[`SignerService`](../classes/modules_signer.SignerService.md)\> + +___ + +### isMetamaskExtensionPresent + +▸ **isMetamaskExtensionPresent**(): `Promise`<{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\> + +#### Returns + +`Promise`<{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\> diff --git a/docs/api/modules/modules_staking.md b/docs/api/modules/modules_staking.md new file mode 100644 index 00000000..c8d3e76a --- /dev/null +++ b/docs/api/modules/modules_staking.md @@ -0,0 +1,46 @@ +# Module: modules/staking + +## Table of contents + +### Enumerations + +- [StakeStatus](../enums/modules_staking.StakeStatus.md) + +### Classes + +- [StakingFactoryService](../classes/modules_staking.StakingFactoryService.md) +- [StakingPoolService](../classes/modules_staking.StakingPoolService.md) + +### Type aliases + +- [Service](modules_staking.md#service) +- [Stake](modules_staking.md#stake) + +## Type aliases + +### Service + +Ƭ **Service**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `org` | `string` | organization ENS name | +| `pool` | `string` | pool address | +| `provider` | `string` | provider address | + +___ + +### Stake + +Ƭ **Stake**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `BigNumber` | +| `depositEnd` | `BigNumber` | +| `depositStart` | `BigNumber` | +| `status` | [`StakeStatus`](../enums/modules_staking.StakeStatus.md) | diff --git a/docs/api/modules/modules_verifiable_credentials.md b/docs/api/modules/modules_verifiable_credentials.md new file mode 100644 index 00000000..9663a90a --- /dev/null +++ b/docs/api/modules/modules_verifiable_credentials.md @@ -0,0 +1,96 @@ +# Module: modules/verifiable-credentials + +## Table of contents + +### Classes + +- [VerifiableCredentialsServiceBase](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md) + +### Interfaces + +- [CreatePresentationParams](../interfaces/modules_verifiable_credentials.CreatePresentationParams.md) +- [IssuerFields](../interfaces/modules_verifiable_credentials.IssuerFields.md) +- [ProofOptions](../interfaces/modules_verifiable_credentials.ProofOptions.md) +- [RoleCredentialSubject](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md) +- [RoleCredentialSubjectParams](../interfaces/modules_verifiable_credentials.RoleCredentialSubjectParams.md) +- [VerifyVerifiableCredentialResults](../interfaces/modules_verifiable_credentials.VerifyVerifiableCredentialResults.md) + +### Variables + +- [verifiableCredentialEIP712Types](modules_verifiable_credentials.md#verifiablecredentialeip712types) +- [verifiablePresentationEIP712Types](modules_verifiable_credentials.md#verifiablepresentationeip712types) +- [verifiablePresentationWithCredentialEIP712Types](modules_verifiable_credentials.md#verifiablepresentationwithcredentialeip712types) + +### Functions + +- [getVerifiableCredentialsService](modules_verifiable_credentials.md#getverifiablecredentialsservice) + +## Variables + +### verifiableCredentialEIP712Types + +• `Const` **verifiableCredentialEIP712Types**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `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' }[] | +| `VerifiableCredential` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | + +___ + +### verifiablePresentationEIP712Types + +• `Const` **verifiablePresentationEIP712Types**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `EIP712Domain` | `never`[] | +| `Proof` | { `name`: `string` = '@context'; `type`: `string` = 'string' }[] | +| `VerifiablePresentation` | { `name`: `string` = '@context'; `type`: `string` = 'string[]' }[] | + +___ + +### verifiablePresentationWithCredentialEIP712Types + +• `Const` **verifiablePresentationWithCredentialEIP712Types**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `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' }[] | +| `VC712Domain` | { `name`: `string` = 'domain'; `type`: `string` = 'VC712DomainData' }[] | +| `VC712DomainData` | `never`[] | +| `VC712DomainSchema` | { `name`: `string` = 'CredentialSubject'; `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`): `Promise`<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerService` | [`SignerService`](../classes/modules_signer.SignerService.md) | + +#### Returns + +`Promise`<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\> diff --git a/docs/guides/application.md b/docs/guides/application.md index 0876ff13..82223cf7 100644 --- a/docs/guides/application.md +++ b/docs/guides/application.md @@ -1,9 +1,9 @@ # Application -[Application Interface](../api/interfaces/IApp.md) +[Application Interface](../api/interfaces/modules_domains.IApp.md) **Application** represents service provided by parent organization. The only domain type contained by application is Role. -Application domain is described by [IApplication](../api/interfaces/IApp.md). +Application domain is described by [IApplication](../api/interfaces/modules_domains.IApp.md). Example of application ``` @@ -26,6 +26,6 @@ Example of application ## Public APIs -- [getAppsByOrgNamespace](../api/classes/DomainsService.md#getAppsOfOrg) -- [createApplication](../api/classes/DomainsService.md#createApplication) -- [deleteApplication](../api/classes/DomainsService.md#deleteApplication) +- [getAppsByOrgNamespace](../api/classes/modules_domains.DomainsService.md#getAppsOfOrg) +- [createApplication](../api/classes/modules_domains.DomainsService.md#createApplication) +- [deleteApplication](../api/classes/modules_domains.DomainsService.md#deleteApplication) diff --git a/docs/guides/asset.md b/docs/guides/asset.md index aa5eed3b..f60a5b7a 100644 --- a/docs/guides/asset.md +++ b/docs/guides/asset.md @@ -6,7 +6,7 @@ To read more about about Assets in EW-DOS, see the [documentation](https://energ The IAM Client Library contains the high-level functions for managing (registering, fetching, transferring ownership, etc.) Assets and their corresponding data. -When a user registers an Asset using the [registerAsset](../api/classes/AssetsService.md#registerasset) method, the user automatically becomes the owner of the Asset. Using the methods in the IAM client library: +When a user registers an Asset using the [registerAsset](../api/classes/modules_assets.AssetsService.md#registerasset) method, the user automatically becomes the owner of the Asset. Using the methods in the IAM client library: - The Asset owner can make an offer to transfer ownership of the Asset to another address. - The offeree can accept or reject the offer of Asset ownership. @@ -14,11 +14,11 @@ When a user registers an Asset using the [registerAsset](../api/classes/AssetsSe ### Public APIs: -- [registerAsset](../api/classes/AssetsService.md#registerasset): Register Asset to the user who initiates the method. This creates a record of the Asset on the Energy Web Chain. -- [getAssetById](../api/classes/AssetsService.md#getassetbyid): Fetch an Asset by its DID. -- [getAssetHistory](../api/classes/AssetsService.md#getassethistory): Fetch an Asset's history by its DID. -- [getOfferedAssets](../api/classes/AssetsService.md#getofferedassets): Fetch all Assets offered to a given DID. These are Assets that have been offered to the user, but not yet confirmed. -- [getOwnedAssets](../api/classes/AssetsService.md#getownedassets): Fetch all Assets owned by a given DID. -- [getPreviouslyOwnedAssets](../api/classes/AssetsService.md#getpreviouslyownedassets): Fetch all Assets previously owned by a given DID. -- [offerAsset](../api/classes/AssetsService.md#offerasset): Offer an Asset to a given address. -- [rejectAssetOffer](../api/classes/AssetsService.md#rejectassetoffer): Reject Asset ownership that has been offered to you as a user. +- [registerAsset](../api/classes/modules_assets.AssetsService.md#registerasset): Register Asset to the user who initiates the method. This creates a record of the Asset on the Energy Web Chain. +- [getAssetById](../api/classes/modules_assets.AssetsService.md#getassetbyid): Fetch an Asset by its DID. +- [getAssetHistory](../api/classes/modules_assets.AssetsService.md#getassethistory): Fetch an Asset's history by its DID. +- [getOfferedAssets](../api/classes/modules_assets.AssetsService.md#getofferedassets): Fetch all Assets offered to a given DID. These are Assets that have been offered to the user, but not yet confirmed. +- [getOwnedAssets](../api/classes/modules_assets.AssetsService.md#getownedassets): Fetch all Assets owned by a given DID. +- [getPreviouslyOwnedAssets](../api/classes/modules_assets.AssetsService.md#getpreviouslyownedassets): Fetch all Assets previously owned by a given DID. +- [offerAsset](../api/classes/modules_assets.AssetsService.md#offerasset): Offer an Asset to a given address. +- [rejectAssetOffer](../api/classes/modules_assets.AssetsService.md#rejectassetoffer): Reject Asset ownership that has been offered to you as a user. diff --git a/docs/guides/claim.md b/docs/guides/claim.md index 7f82d671..26c57960 100644 --- a/docs/guides/claim.md +++ b/docs/guides/claim.md @@ -1,8 +1,8 @@ # Claims -+ [Claim Interface](../api/interfaces/Claim.md) -+ [Claim Request Interface](../api/interfaces/IClaimRequest.md) -+ [Claim Issuance Interface](../api/interfaces/IClaimIssuance.md) -+ [Claims Service API documentation](../api/classes/ClaimsService.md) ++ [Claim Interface](../api/interfaces/modules_claims.Claim.md) ++ [Claim Request Interface](../api/interfaces/modules_claims.IClaimRequest.md) ++ [Claim Issuance Interface](../api/interfaces/modules_claims.IClaimIssuance.md) ++ [Claims Service API documentation](../api/classes/modules_claims.ClaimsService.md) ## Overview At the most fundamental level, a claim is a statement about a subject. A claim is a component of a Verifiable Credential, which is the web3 standard for digital credentials in a decentralized ecosystem. @@ -54,9 +54,9 @@ Depending on if the requester wants to register the claim On-Chain and/or Off-Ch Claim data is also persisted by the [IAM Cache Server](https://github.com/energywebfoundation/iam-cache-server/tree/master/src/modules/claim) in the Role Claim Repository. The IAM Client library's Claim Service methods post claim data to the Cache Server, where the data is persisted by the Cache Server's Claims Service methods. View the Cache Server's [Claim Service on GitHub](https://github.com/energywebfoundation/iam-cache-server/blob/master/src/modules/claim/claim.service.ts#L422). ### 1. Requesting Claims -A claim request is created by the signer and submitted to the Role issuer(s) using the [createClaimRequest](../api/classes/ClaimsService.md#createclaimrequest) method. +A claim request is created by the signer and submitted to the Role issuer(s) using the [createClaimRequest](../api/classes/modules_claims.ClaimsService.md#createclaimrequest) method. -The createClaimRequest method creates a claim request message (of type [IClaimRequest](../api/interfaces/IClaimRequest.md)), and sends the message to the [IAM cache server](https://github.com/energywebfoundation/iam-cache-server/tree/master/src/modules/claim): +The createClaimRequest method creates a claim request message (of type [IClaimRequest](../api/interfaces/modules_claims.IClaimRequest.md)), and sends the message to the [IAM cache server](https://github.com/energywebfoundation/iam-cache-server/tree/master/src/modules/claim): ``` const message: IClaimRequest = { @@ -89,10 +89,10 @@ The IAM cache server then: See the Cache Server request handler [here](https://github.com/energywebfoundation/iam-cache-server/blob/07a0053cd10ad16739cc331f043b18cc5dfc0dc4/src/modules/claim/claim.controller.ts#L112). ### 2. Issuing Claims -If the subject's enrolment request is valid, the Issuer can approve and issue the claim to the subject. If the claim has been requested by the signer, this is done by the [issueClaimRequest method](../api/classes/ClaimsService.md#issueclaimrequest). If a claim is being directly issued without having been requested, this is done by the [issueClaim method](../api/classes/ClaimsService.md#issueclaim). +If the subject's enrolment request is valid, the Issuer can approve and issue the claim to the subject. If the claim has been requested by the signer, this is done by the [issueClaimRequest method](../api/classes/modules_claims.ClaimsService.md#issueclaimrequest). If a claim is being directly issued without having been requested, this is done by the [issueClaim method](../api/classes/modules_claims.ClaimsService.md#issueclaim). #### Registering Claims on the Blockchain -A claim request has an array of [RegistrationTypes](../api/enums/RegistrationTypes.md). A claim can be registered: +A claim request has an array of [RegistrationTypes](../api/enums/modules_claims.RegistrationTypes.md). A claim can be registered: 1. On-Chain only 2. Off-Chain only @@ -195,7 +195,7 @@ The registerOnChain method registers the role with the ClaimManager smart contra In the [ClaimManager contract's register method](https://github.com/energywebfoundation/iam-contracts/blob/83932a8fee56010482b50047ea5a20da37b758da/contracts/roles/ClaimManager.sol#L89), the claim data is added to the 'roles' mapping, and can then be accessed and read by other smart contracts on the blockchain. -**Note:** An issuer can directly issue a claim directly without a request. This is done through the [issueClaim method](../api/classes/ClaimsService.md#issueclaim). **This method does not handle On-Chain registration**. +**Note:** An issuer can directly issue a claim directly without a request. This is done through the [issueClaim method](../api/classes/modules_claims.ClaimsService.md#issueclaim). **This method does not handle On-Chain registration**. ### 3. Alternatives to Claim Issuance @@ -239,7 +239,7 @@ The deleteClaimRequest method is used to delete a claim request: The claim is [deleted from the role claim repository in the Cache Server](https://github.com/energywebfoundation/iam-cache-server/blob/07a0053cd10ad16739cc331f043b18cc5dfc0dc4/src/modules/claim/claim.service.ts#L422). ### Claim Interface -Issued role claims are of type [Claim](../api/interfaces/Claim.md) +Issued role claims are of type [Claim](../api/interfaces/modules_claims.Claim.md) Example role claim: ``` @@ -282,7 +282,7 @@ The UUID identifier for the claim + **registrationTypes** -The claim's [Registration Types](../api/enums/RegistrationTypes.md), which can be On-Chain or Off-Chain, or both. These are explained in greater detail [above](#off-chain-registration). +The claim's [Registration Types](../api/enums/modules_claims.RegistrationTypes.md), which can be On-Chain or Off-Chain, or both. These are explained in greater detail [above](#off-chain-registration). + **subjectAgreement** @@ -397,16 +397,16 @@ Example of authentication token: ## Claims Service Public APIs -- [getClaimsId](../api/classes/ClaimsService.md#getclaimid) -- [getClaimsByIssuer](../api/classes/ClaimsService.md#getclaimsbyissuer) -- [getClaimsByRequester](../api/classes/ClaimsService.md#getclaimsbyrequester) -- [getClaimsBySubject](../api/classes/ClaimsService.md#getclaimsbysubject) -- [getUserClaims](../api/classes/ClaimsService.md#getuserclaims) -- [issueClaimRequest](../api/classes/ClaimsService.md#issueclaimrequest) -- [issueClaim](../api/classes/ClaimsService.md#issueclaim) -- [rejectClaimRequest](../api/classes/ClaimsService.md#rejectclaimrequest) -- [issuePublicClaim](../api/classes/ClaimsService.md#issuepublicclaim) -- [publishPublicClaim](../api/classes/ClaimsService.md#publishpublicclaim) -- [registerOnChain](../api/classes/ClaimsService.md#registeronchain) +- [getClaimsId](../api/classes/modules_claims.ClaimsService.md#getclaimid) +- [getClaimsByIssuer](../api/classes/modules_claims.ClaimsService.md#getclaimsbyissuer) +- [getClaimsByRequester](../api/classes/modules_claims.ClaimsService.md#getclaimsbyrequester) +- [getClaimsBySubject](../api/classes/modules_claims.ClaimsService.md#getclaimsbysubject) +- [getUserClaims](../api/classes/modules_claims.ClaimsService.md#getuserclaims) +- [issueClaimRequest](../api/classes/modules_claims.ClaimsService.md#issueclaimrequest) +- [issueClaim](../api/classes/modules_claims.ClaimsService.md#issueclaim) +- [rejectClaimRequest](../api/classes/modules_claims.ClaimsService.md#rejectclaimrequest) +- [issuePublicClaim](../api/classes/modules_claims.ClaimsService.md#issuepublicclaim) +- [publishPublicClaim](../api/classes/modules_claims.ClaimsService.md#publishpublicclaim) +- [registerOnChain](../api/classes/modules_claims.ClaimsService.md#registeronchain) For detailed description of the enrolment flow process, see the [Claims Service end-to-end tests](https://github.com/energywebfoundation/iam-client-lib/blob/master/e2e/claims.service.e2e.ts). \ No newline at end of file diff --git a/docs/guides/organization.md b/docs/guides/organization.md index ab3c96d8..1579b5ba 100644 --- a/docs/guides/organization.md +++ b/docs/guides/organization.md @@ -1,11 +1,11 @@ # Organization -[Organization Interface](../api/interfaces/IOrganization.md) +[Organization Interface](../api/interfaces/modules_domains.IOrganization.md) **Organization** is basic type in EnergyWeb domains tree. Its main purpose is to be a root that can group other domains, such as apps and roles. All other domains such as applications and roles should have parent organization. If needed organization can include other sub-organizations. Organization is represented by -[`IOrganization`](../api/interfaces/IOrganization.md) interface. Organizations can +[`IOrganization`](../api/interfaces/modules_domains.IOrganization.md) interface. Organizations can be created either as way to structure system or group correlated entities along with permissions hierarchy. Organization owner as well as its components owners can be changed. Example of organization @@ -32,6 +32,6 @@ Example of organization ## Public APIs: -- [createOrganization](../api/classes/DomainsService.md#createorganization) -- [deleteOrganization](../api/classes/DomainsService.md#deleteorganization) -- [getOrgHierarchy](../api/classes/DomainsService.md#getorghierarchy) +- [createOrganization](../api/classes/modules_domains.DomainsService.md#createorganization) +- [deleteOrganization](../api/classes/modules_domains.DomainsService.md#deleteorganization) +- [getOrgHierarchy](../api/classes/modules_domains.DomainsService.md#getorghierarchy) diff --git a/docs/guides/role.md b/docs/guides/role.md index d8069624..b449b437 100644 --- a/docs/guides/role.md +++ b/docs/guides/role.md @@ -1,6 +1,6 @@ # Roles -[Role Interface](../api/interfaces/IRole.md) +[Role Interface](../api/interfaces/modules_domains.IRole.md) **Role** is leaf in EnergyWeb domains tree. Its main purpose is to distribute responsibilities and permissions in some domain. As part of its definition, role determines the permissions of its @@ -9,7 +9,7 @@ of some other role. Similarly, a role can also be used a prerequisite for issuance. A role can be placed under organization or application thus defining its scope. -Role is represented by [`IRole`](../api/interfaces/IRole.md) interface. +Role is represented by [`IRole`](../api/interfaces/modules_domains.IRole.md) interface. Example of role ``` @@ -49,9 +49,9 @@ Example of role ## Public APIs: -- [createRole](../api/classes/DomainsService.md#createrole) -- [setRoleDefinition](../api/classes/DomainsService.md#setroledefinition) -- [getRolesByNameSpace](../api/classes/DomainsService.md#getrolesbynamespace) -- [getRoleDIDs](../api/classes/DomainsService.md#getroledids) -- [changeRoleOwnership](../api/classes/DomainsService.md#changeroleownership) -- [deleteRole](../api/classes/DomainsService.md#deleterole) +- [createRole](../api/classes/modules_domains.DomainsService.md#createrole) +- [setRoleDefinition](../api/classes/modules_domains.DomainsService.md#setroledefinition) +- [getRolesByNameSpace](../api/classes/modules_domains.DomainsService.md#getrolesbynamespace) +- [getRoleDIDs](../api/classes/modules_domains.DomainsService.md#getroledids) +- [changeRoleOwnership](../api/classes/modules_domains.DomainsService.md#changeroleownership) +- [deleteRole](../api/classes/modules_domains.DomainsService.md#deleterole) diff --git a/mkdocs.yml b/mkdocs.yml index 0758392e..e9a01b16 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,16 +1,26 @@ site_name: IAM Client Library nav: - 'Quick start': 'Quick_start.md' - - 'Introduction': - - 'Overview': intro/overview.md - - 'Architecture': intro/architecture.md + - Introduction: + - Overview: intro/overview.md + - Architecture: intro/architecture.md - 'Domain Hierarchy': intro/domainhierarchy.md - - 'Guides': - - 'Application': guides/application.md - - 'Asset': guides/asset.md - - 'Organization': guides/organization.md - - 'Claims': guides/claim.md - - API: api/modules.md + - Guides: + - Application: guides/application.md + - Asset: guides/asset.md + - Organization: guides/organization.md + - Claims: guides/claim.md + - 'API': + - Initialization: api/modules/init.md + - Assets: api/modules/modules_assets.md + - Cache Client: api/modules/modules_cacheClient.md + - Claims: api/modules/modules_claims.md + - 'Did registry': api/modules/modules_didRegistry.md + - Domains: api/modules/modules_domains.md + - Messaging: api/modules/modules_messaging.md + - Signer: api/modules/modules_signer.md + - Staking: api/modules/modules_staking.md + - 'Verifiable credentials': api/modules/modules_verifiable_credentials.md - CHANGELOG: CHANGELOG.md theme: name: material diff --git a/typedoc.json b/typedoc.json index 3b40a1a0..beea5755 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,9 +1,21 @@ { - "entryPoints": ["src/"], + "entryPoints": [ + "src/init.ts", + "src/modules/assets", + "src/modules/cacheClient", + "src/modules/claims", + "src/modules/didRegistry", + "src/modules/domains", + "src/modules/messaging", + "src/modules/signer", + "src/modules/staking", + "src/modules/verifiable-credentials" + ], "out": ["docs/api"], "disableSources": true, "excludePrivate": true, "excludeProtected": true, "excludeExternals": true, - "cleanOutputDir": true + "cleanOutputDir": true, + "categorizeByGroup": false }